POST /payout-request-allocations
Creates an allocation for a payout request.
When an allocation is created, the payout request transitions to the in-progress status,
and the allocation starts in the pending status.
The allocation transitions to the processing status when payment processing begins.
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 |
|---|---|---|---|
payoutRequestId |
String | Yes |
ID of the payout request to allocate. |
amount |
Number | Yes |
Amount to allocate to this payment instrument. |
gatewayAccountId |
String | Yes |
ID of the gateway account. |
paymentInstrumentId |
String | Yes |
ID of the payment instrument to allocate. |
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.