ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/payout-requests/{id}
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/payout-requests/{id}
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/payout-requests/{id}
curl -i -X GET \
'https://www.rebilly.com/_mock/catalog/all/payout-requests/{id}' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'ID of the payout request from which this request is split, or null if this request is not created by a split operation.
ID of the payout request that this request is merged into, or null if it is not merged into another request.
| Enum Value | Description |
|---|---|
| pending | Request was created by the customer and is in a pending state for the configured pending period, unless it is marked as ready by a member of your organization. When automatic readiness is enabled, the payout request transitions to the |
| ready | Request was created by the customer and is ready for review. Depending on the configured |
| approved | |
| in-progress | |
| fulfilled | |
| canceled | |
| split | |
| merged |
Specifies if the payout request is blocked or unblocked.
When blocked, the payout request cannot transition to ready, approved, in-progress, merged, or split. Allocation creation and allocation processing are also blocked. Cancellation of the payout request and pending allocations remains available. When a blocked payout request is canceled, blocked is set to false, blockReason is set to null, and the block reason is added to the cancellation description. If allocation processing starts before the payout request is blocked, the request still transitions to the fulfilled status.
Specifies if at least one allocation for the payout request has the returned status. The status of the payout request does not change.
Short name of the payout request batch that contains this request. This value is null if the request is not in a batch or the batch has no name.
Description of the payout request batch that contains this request. This value is null if the request is not in a batch or the batch has no description.
URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.
{ "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "splitFromPayoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "mergedIntoPayoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "currency": "USD", "amount": 0.1, "availableAmount": 0.1, "description": "string", "status": "pending", "blocked": false, "hasReturnedAllocations": false, "blockReason": "fraud-suspected", "splitReason": "payment-instrument-limit", "batchId": "prb_0YVDMDE2BMC6KBB5MX76RF6T80", "batchName": "Weekly CAD payouts", "batchDescription": "Batch processed on 2024-01-15", "selectPaymentInstrumentUrl": "http://example.com", "allocations": [ { … } ], "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success", "cancellationReason": { "canceledBy": "merchant", "description": "string" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }