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.
Payout request resource.
| websiteId required | string (WebsiteId) <= 50 characters 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 required | string (CustomerId) <= 50 characters ID of the customer resource. |
| paymentInstrumentId | string or null <= 50 characters ID of the requested payment instrument to offer for the payout. |
| currency required | string (CurrencyCode) = 3 characters Currency code in ISO 4217 format. |
| amount required | number <double> Amount of the payout. |
| description | string or null Description of payout request. |
| selectedPaymentInstrumentRedirectUrl | string <uri> URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use |
{ "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "description": "string", "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}" }
201
Payout request created.
401
Unauthorized access. Invalid credentials used.
403
Access forbidden.
422
Invalid data sent.
{ "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "availableAmount": 0.1, "description": "string", "status": "pending", "selectPaymentInstrumentUrl": "http://example.com", "allocations": [ { "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "transactionResult": "abandoned", "method": "payment-card", "gatewayName": "A1Gateway", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "amount": 0.1, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z" } ], "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}", "cancellationReason": { "canceledBy": "merchant", "description": "string" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { "href": "string", "rel": "self" } ] }