WooshPay OpenAPI
Create a payout
POST/v1/payoutsRequest
Three-letter ISO currency code, in lowercase.
Conditional required. Amount (in cents) to be transferred to your bank account or debit card.
Source currency, i.e. the currency that the Payer uses to fund the payment
Conditional required. Source amount in source_currency
An arbitrary string attached to the object. Often useful for displaying to users.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
ID of the beneficiary the payout was sent to. Conditional required: one of beneficiary and beneficiary_data are required.
Beneficiary details of the payout are added if there is no existing one. Conditional required: one of beneficiary and beneficiary_data are required.
Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required.
Nickname of beneficiary for quickly retrieving
Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary
{
"payment_amount": 124000,
"source_amount": 10000,
"payment_currency": "INR",
"source_currency": "INR",
"beneficiary_data": {
"nickname": "test1",
"destination_data": {
"destination_type": "upi",
"upi": {
"vpa": "8276831583@axl",
"phone_number": "91-8276831583"
}
}
}
}Request samples
Responses
Unique identifier for the object, "po_XXXX"
"payout"
Time at which the object was created. Measured in seconds since the Unix epoch.
Three-letter ISO currency code, in lowercase.
Conditional required.Amount (in cents) to be transferred to your bank account or debit card.
Source currency, i.e. the currency that the Payer uses to fund the payment
Conditional required. Source amount in source_currency
An arbitrary string attached to the object. Often useful for displaying to users.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days).
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
The entiry who receives the payout. Conditional required: one of beneficiary and beneficiary_data are required.
Unique identifier for the object, "bn_xxxxx".
"beneficiary"
The time at which the object was created. Measured in seconds since the Unix epoch.
Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required.
Nickname of beneficiary for quickly retrieving
Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
ID of the beneficiary the payout was sent to. Conditional required: one of beneficiary and beneficiary_data are required.
Error code explaining reason for payout failure if available.
Message to user further explaining reason for payout failure if available.
A list of payment intent id attached to this payout object as the payouts was sent to China.
(未实现)The method used to send this payout, which can be standard or instant.
{
"id": "po_1854715844924276736",
"object": "payout",
"created": 1731033692000,
"livemode": false,
"status": "pending",
"beneficiary_data": {
"id": "bf_1854477747879936000",
"object": "beneficiary",
"created": 1731033691000,
"livemode": false,
"nickname": "test1",
"destination_data": {
"imps": {
"vpa": "8276831583@axl",
"phone_number": "91-8276831583"
},
"destination_type": "upi"
}
},
"payment_amount": 124000,
"payment_currency": "INR",
"source_amount": 124000,
"source_currency": "INR"
}