Create a beneficiary - 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

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.

destination_type

enum<string>

required

Payment method

Allowed values:

bank_accountcardcarrier_billingalipay

bank_account

object

optional

Condtional requried

card

object

optional

Condtional requried

carrier_billing

object

optional

Condtional requried

alipay

object

optional

Condtional requried

imps

object

optional

Condtional requried

upi

object

optional

Condtional requried

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

Example

{
    "entity": {
        "type": "individual",
        "individual": {
            "address": {
                "city": "seattle",
                "country": "US",
                "line1": "422 Ave",
                "state": "Washington",
                "postal_code": "98109"
            },
            "additional_info": {
                "email": "liuyidao@126.com",
                "phone": "12093321241",
                "last_name": "Wick",
                "first_name": "John",
                "id_type": "social_security",
                "id_country_iso_code": "US",
                "id_number": "WA112313411"
            }
        }
    },
    "nickname": "test2",
    "destination_data": {
        "destination_type": "bank_account",
        "bank_account": {
            "country": "US",
            "currency": "USD",
            "swift": "ABOCUSSE080",
            "account_holder_name": "Bill Han",
            "account_holder_type": "individual",
            "routing_number": "1051000017",
            "account_number": "123123123",
            "bank_name": "Bank of America"
        }
    }
}

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/beneficiaries' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "entity": {
        "type": "individual",
        "individual": {
            "address": {
                "city": "seattle",
                "country": "US",
                "line1": "422 Ave",
                "state": "Washington",
                "postal_code": "98109"
            },
            "additional_info": {
                "email": "liuyidao@126.com",
                "phone": "12093321241",
                "last_name": "Wick",
                "first_name": "John",
                "id_type": "social_security",
                "id_country_iso_code": "US",
                "id_number": "WA112313411"
            }
        }
    },
    "nickname": "test2",
    "destination_data": {
        "destination_type": "bank_account",
        "bank_account": {
            "country": "US",
            "currency": "USD",
            "swift": "ABOCUSSE080",
            "account_holder_name": "Bill Han",
            "account_holder_type": "individual",
            "routing_number": "1051000017",
            "account_number": "123123123",
            "bank_name": "Bank of America"
        }
    }
}'

Responses

🟢200OK

application/json

Body

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.

destination_type

enum<string>

required

Payment method

Allowed values:

bank_accountcardcarrier_billingalipay

bank_account

object

optional

Condtional requried

card

object

optional

Condtional requried

carrier_billing

object

optional

Condtional requried

alipay

object

optional

Condtional requried

imps

object

optional

Condtional requried

upi

object

optional

Condtional requried

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.

Example

{
    "id": "string",
    "object": "string",
    "created": 0,
    "destination_data": {
        "destination_type": "bank_account",
        "bank_account": {
            "account_number": "string",
            "account_holder_name": "string",
            "account_holder_type": "individual",
            "phone_number": "string",
            "email": "string",
            "country": "string",
            "swift": "string",
            "dob": {
                "day": "string",
                "month": "string",
                "year": "string"
            },
            "gender": "male",
            "certificate": {
                "certificate_type": "id_card",
                "certificate_number": "string"
            },
            "bank_name": "string",
            "metadata": {},
            "routing_number": "string",
            "routing_type": "aba",
            "description": "string"
        },
        "card": {
            "name": "string",
            "number": "string",
            "description": "string",
            "billing_address": {
                "address": {
                    "city": "string",
                    "country": "string",
                    "line1": "string",
                    "line2": "string",
                    "postal_code": "string",
                    "state": "string"
                }
            },
            "metadata": {}
        },
        "carrier_billing": {
            "carrier": "megafon",
            "phone_number": "string",
            "country": "string",
            "description": "string"
        },
        "alipay": {
            "user_id": "string",
            "first_name": "string",
            "last_name": "string"
        },
        "imps": {
            "account_number": "string",
            "phone_number": "string",
            "email": "string",
            "name": "string",
            "bank_code": "string"
        },
        "upi": {
            "vpa": "string",
            "phone_number": "string"
        }
    },
    "nickname": "string",
    "metadata": {},
    "livemode": true
}