- Retrieve a payout request allocation
Retrieves a payout request allocation with a specified ID.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/payout-request-allocations/{id}
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/payout-request-allocations/{id}
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/payout-request-allocations/{id}
- SecretApiKey
- JWT
curl -i -X GET \
'https://www.rebilly.com/_mock/catalog/all/payout-request-allocations/{id}' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Payout request allocation retrieved.
ID of the payout request associated with this allocation.
ID of the payout request batch that contains the payout request for this allocation.
ID of the payment instrument allocated to the payout request.
Payment method of the allocation.
ID of the gateway account to use for processing this allocation.
Name of the gateway account to use for processing this allocation.
Payout configuration of the gateway account that processes this allocation.
| Enum Value | Description |
|---|---|
| all | Payout any amount from this gateway. |
| covered-payout | Payout from this gateway if it previously processed a payment for the same, or a greater, amount. |
| approved-payment | Payout any amount from this gateway if it processed an earlier payment. The customer must have a previously approved transaction, in the same currency, on this gateway. |
| none | Do not allow any payouts with this gateway. |
Total approved sales and captures minus approved payouts for the customer, gateway account, and payment instrument, in the allocation currency.
Currency of the payout request allocation.
Status of this payout request allocation.
| Enum Value | Description |
|---|---|
| pending | Allocation was created and is waiting to be processed. |
| queued | Allocation is queued for processing. |
| processing | Allocation is being processed and a transaction is being created. |
| waiting-completion | Allocation transaction is processing asynchronously and has not yet reached a terminal state. |
| completed | Allocation was successfully processed and the transaction was approved. |
| failed | Allocation was not processed because of an error. |
| canceled | Allocation was canceled before processing. |
| declined | Allocation was declined by the gateway. |
ID of the transaction that is created when processing this allocation, if applicable.
Result of the transaction created for this allocation, if applicable.
Status of the transaction created for this allocation, if applicable.
Date and time when the allocation for the payout request was created.
Date and time when the resource is updated. This value is set automatically when the resource is updated.
{ "id": "pra_0YVDMDE2BMC6KBB5MX76RF6T80", "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "batchId": "preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "paymentMethod": "payment-card", "gatewayAccountId": "gateway_0YVB8KPKNXCBR9EDX7JHSED75N", "gatewayName": "TestProcessor", "gatewayPayoutInstruction": "covered-payout", "amount": 0.1, "exposureAmount": 2, "currency": "USD", "status": "pending", "transactionId": "txn_0YVB8KPKNXCBR9EDX7JHSED75N", "transactionResult": "abandoned", "transactionStatus": "completed", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }