API Reference

Create a Cross-border Sender

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

Create an individual or business sender.

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

Create an individual or business sender. Save data.id as senderId. Email must be unique among active senders in your account. Individual fields and business fields are mutually exclusive. Sandbox: use the same suffix under /api/sandbox/b2b/cross-border/requests with a sandbox bearer token.

Follow the cross-border guide and sandbox testing guide.

Individuals require idNumber and omit registrationNumber. Businesses require registrationNumber and omit idNumber. Both number fields accept 2–200 characters. idType accepts passport, national-id, or business-registration-number; use the value describing the supplied identity or registration document.

See Status, webhooks and retries for response envelopes, pagination and recovery rules.

Body Params
string
required
^\+[1-9]\d{1,14}$

International phone number including + and country calling code.

string
required
length ≤ 254

Unique among active senders in your account; normalized to lowercase.

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

Two-letter country code, uppercase.

string
required
length between 2 and 200

Personal identity document number. Required for individual senders; omit registrationNumber.

string
^[A-Z]{2}$

Two-letter country code, uppercase.

address
object
required
string
enum
required
Allowed:
string
required
length between 2 and 255

Letters, spaces, apostrophes and hyphens.

string
required
length between 2 and 255

Letters, spaces, apostrophes and hyphens.

string
required
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$

Date of birth in YYYY-MM-DD format.

Responses

Updated 1 day 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 1 day ago