API Reference

Create a Cross-border Beneficiary

post
https://api-v2.honeycoin.app/api/b2b/cross-border/requests/beneficiaries

Register recipient identity and payout instructions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Register recipient identity and payout instructions. accountName is derived from personal names or companyName; do not supply it. Reuse data.id as beneficiaryId. Active account numbers must be unique per account. Alipay requires an individual beneficiary and does not accept idType, idCountry, or idNumber. Individual bank beneficiaries require idType, idCountry, and idNumber. Business bank beneficiaries require idType, idCountry, and registrationNumber; idNumber is forbidden.

See beneficiaries, supporting documents, and sandbox testing.

Body Params
string
enum
required
Allowed:
string
enum

Type of the beneficiary identity or registration document. Required for bank payouts; not accepted for Alipay.

Allowed:
string
^[A-Z]{2}$

Two-letter uppercase country that issued the beneficiary identity or registration document. Required for bank payouts; not accepted for Alipay.

string
length between 2 and 200

Beneficiary personal identity document number. Required for bank payouts; not accepted for Alipay.

payoutDetails
required

Payout instructions supplied when registering a beneficiary. The service derives accountName from the recipient name.

string
required
length between 2 and 255
string
required
length between 2 and 255
Responses

Updated 5 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago