Payout Required Information

What to Collect from Users	Description	Request Field	Example
Recipient's Full Name	The full name of the bank account holder, must match bank records	`account_holder_name`	Simon Smith
Account Number	The recipient's bank account number (typically 8-12 digits, without spaces or special characters)	`account_number`	06137128
Sort Code Type	International standard code identifying the routing number type (common types: sort code for UK, ABA for US)	`routing_type`	sort
Bank Branch Identifier	Specific branch number of the recipient's bank (format varies by country, e.g. 6-digit sort code for UK)	`routing_number`	00290019
Recipient Bank Country	Use ISO 3166-1 two-letter country codes	`country`	Example for UK: GB

Supported Payout Methods

Payout Method	Supported Currency
Bank account	GBP

Request Example

Below example shows the minimum parameter set. Parameter reference: [Create a Payout]
account name: luhudaxue
routing_type: sort
routing_number: 123123
account_number: 12121212
country: GB

text

{
    "payment_currency": "GBP",
    "payment_amount": 5500,
    "source_currency": "GBP",
    "beneficiary_data": {
        "destination_data": {
            "destination_type": "bank_account",
            "bank_account": {
                "account_number": "12121212",
                "account_holder_name": "luhudaxue",
                "routing_type": "sort",
                "routing_number": "123123",
                "country": "GB"
            }
        }
    },
    "merchant_payout_id": "pay_123123123"
}

Retrieve a Payout

GET：/v1/payouts/{id}

Webhook

Create Webhook

POST：/v1/webhook_endpoints

{
    "url": "https://...", //用于接收Webhook的url
    "description": "I am description",
    "enabled_events": [
        "payout.canceled",
        "payout.created",
        "payout.failed",
        "payout.paid",
        "payout.updated"
    ]
}

Once a webhook is successfully registered, an HTTPS request will be automatically sent to the registered URL whenever any of the specified events occur.

Test Webhook

Create a payout to trigger thepayout.createdevent. This will send a callback notification about the payout creation event to your designated Webhook URL.

UK

Payout Required Information#

Supported Payout Methods#

Request Example#

Retrieve a Payout#