Create a beneficiary

POST

/v1/beneficiaries

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

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Example

{
    "id": "string",
    "object": "string",
    "created": 0,
    "destination_data": {
        "destination_type": "bank_account",
        "bank_account": {
            "account_number": "string",
            "iban": "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
}

Modified at 2024-11-04 07:07:06

Retrieve a refund

Retrieve a beneficiary