POST /payout-requests
Creates a payout request.
In the response, the selectPaymentInstrumentUrl field is used to redirect the customer to select a preferred payment instrument.
After a payment instrument is selected, the customer is redirected to the selectedPaymentInstrumentRedirectUrl value.
Important: The selected payment gateway must be configured to support payout requests. For more information, see the readyToPayoutInstruction field.
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 |
|---|---|---|---|
availableAmount |
Number | No |
Available payout request amount that has not been allocated. |
description |
String | No |
Description of payout request. |
createdTime |
String | No |
Date and time when the payout request is created. |
status |
String | No |
Status of the request. Valid values:
|
blockReason |
Object | No | |
currency |
String | Yes |
Currency of the 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. |
customerId |
String | Yes |
ID of the customer who is requesting a payout. |
allocations[] |
Array | No |
List of credit transactions that are allocated to reduce the available amount of a payout request. |
allocations[].method |
String | No |
Payment method. Valid values:
|
allocations[].updatedTime |
String | No |
Date and time when the payout request is updated. |
allocations[].transactionResult |
String | No |
Result of the transaction. Valid values:
|
allocations[].createdTime |
String | No |
Date and time when the payout request is created. |
allocations[].amount |
Number | No |
Payout amount that is allocated from the payout request to the credit transaction. |
allocations[].transactionId |
String | No |
ID of the transaction to which the payout request is allocated. |
allocations[].currency |
String | No |
Currency of the payout. |
allocations[].gatewayName |
String | No |
Name of the payment gateway that processed, or is selected to process, the transaction. Valid values:
|
allocations[].paymentInstrumentId |
String | No |
ID of the selected payment instrument for the transaction. |
id |
String | No |
Unique resource ID. |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
batchId |
String | No |
ID of the payout request batch that contains this request. |
updatedTime |
String | No |
Date and time when the payout request is updated. |
amount |
Number | Yes |
Amount of the payout. |
blocked |
Boolean | No |
Specifies whether the payout request is blocked or unblocked. |
selectPaymentInstrumentUrl |
String | No |
URL for the customer to select a preferred payment instrument. |
selectedPaymentInstrumentRedirectUrl |
String | No |
URL where the customer is redirected when a payment instrument is selected. The default value is the website URL.
Use |
cancellationReason |
Object | No |
Reason the payout request is canceled. |
cancellationReason.description |
String | No |
Description of the cancellation reason in free form. |
cancellationReason.canceledBy |
String | No |
Specifies who initiated the cancellation. Valid values:
Default value: "customer" |
paymentInstrumentId |
String | No |
ID of the requested payment instrument to offer for the payout. |
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.