Create a payout - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

payment_currency

string

required

Three-letter ISO currency code, in lowercase.

payment_amount

integer

optional

Conditional required. Amount (in cents) to be transferred to your bank account or debit card.

source_currency

string

required

Source currency, i.e. the currency that the Payer uses to fund the payment

source_amount

integer

optional

Conditional required. Source amount in source_currency

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users.

metadata

object

optional

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.

beneficiary

string

optional

ID of the beneficiary the payout was sent to. Conditional required: one of beneficiary and beneficiary_data are required.

beneficiary_data

object

optional

Beneficiary details of the payout are added if there is no existing one. Conditional required: one of beneficiary and beneficiary_data are required.

destination_data

object

required

Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required.

nickname

string

optional

Nickname of beneficiary for quickly retrieving

metadata

object

optional

Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary

payer_data

object (Payer)

optional

payer_type

enum<string>

optional

Allowed values:

individualbusiness

individual

object

optional

business

object

optional

merchant_payout_id

string

optional

Example

{
    "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

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apitest.wooshpay.com/v1/payouts' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "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"
            }
        }
    }
}'

Responses

🟢200OK

application/json

Body

id

string

optional

Unique identifier for the object, "po_XXXX"

object

string

optional

"payout"

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

payment_currency

string

optional

Three-letter ISO currency code, in uppercase.

payment_amount

integer

optional

Conditional required.Amount (in cents) to be transferred to your bank account or debit card.

source_currency

string

optional

Source currency, i.e. the currency that the Payer uses to fund the payment

source_amount

integer

optional

Conditional required. Source amount in source_currency

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users.

metadata

object

optional

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.

status

string

optional

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).

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

beneficiary_data

object

optional

The entiry who receives the payout. Conditional required: one of beneficiary and beneficiary_data are required.

id

string

optional

Unique identifier for the object, "bn_xxxxx".

object

string

optional

"beneficiary"

created

integer

optional

The time at which the object was created. Measured in seconds since the Unix epoch.

destination_data

object

required

Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required.

nickname

string

optional

Nickname of beneficiary for quickly retrieving

metadata

object

optional

Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

beneficiary

string

optional

ID of the beneficiary the payout was sent to. Conditional required: one of beneficiary and beneficiary_data are required.

failure_code

enum<string>

optional

Error code explaining reason for payout failure if available.

Allowed values:

account_closedaccount_frozenbank_account_restrictedbank_ownership_changedcould_not_processdebit_not_authorizeddeclinedinsufficient_fundsinvalid_account_numberincorrect_account_holder_nameincorrect_account_holder_addressincorrect_account_holder_tax_idinvalid_currencyno_accountunsupported_card

failure_message

string

optional

Message to user further explaining reason for payout failure if available.

payer_data

object (Payer)

optional

payer_type

enum<string>

optional

Allowed values:

individualbusiness

individual

object

optional

business

object

optional

payment_intents_id

array[string]

optional

A list of payment intent id attached to this payout object as the payouts was sent to China.

method

enum<string>

optional

(未实现)The method used to send this payout, which can be standard or instant.

Allowed values:

standardinstant

merchant_payout_id

string

optional

Example

{
    "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"
}