POST /cashiers
Creates a cashier resource for a specific customer, website, and currency.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
pendingPayoutTotal |
Number | No |
Sum of all payout requests that are currently in a pending state. This value is also the maximum possible "reverse withdrawal" amount. |
redirectUrl |
String | No |
URL to redirect the customer to when a deposit or withdrawal is completed. The default value is the website URL. |
balance |
Number | No |
Current cash balance of the customer. |
depositLimits |
Object | No |
Deposit limits for the customer. This object is used to set the minimum and maximum deposit limits for the customer. |
depositLimits.minimum |
Number | No |
Minimum deposit limit. |
depositLimits.maximum |
Number | No |
Maximum deposit limit. |
bonusBalance |
Number | No |
Bonus balance available to the customer. |
currency |
String | Yes |
Currency of the payout request allocation. |
notificationUrl |
String | No |
URL where a server-to-server Do not interpret this notification as a confirmation,
complete a The following placeholders are available to use in this URI: |
customerId |
String | Yes |
ID of the customer who is requesting a payout. |
websiteId |
String | Yes |
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.