Create a Cross-Border Payment
Creates a cross-border payment from a platform user’s wallet to a saved payee bank.
Send:
payer_id(aliasuser_id) — the user funding the paymentpayee_id— the payeeto_bank_id— the saved payee bankamount— the source amount in USD, pluspayout_currency,invoice_noand an optionaldescription
Amount limits (the source amount in USD, both inclusive):
- Minimum amount:
$10 USD - Maximum amount:
$5,000 USD
A request below the minimum or above the maximum is rejected with AMOUNT_OUT_OF_RANGE, and the error
payload echoes min_amount, max_amount and currency (USD).
Also rejects with COUNTRY_NOT_ALLOWED if the payee country is not enabled for the platform, or
MISSING_REQUIRED_FIELDS when a required payee field is missing. Returns the created payment;
progress is delivered via payment.* webhooks.
Headers
Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.
HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.
Body
Platform-side cross-border payout request.
A cross-border payout always debits the payer's wallet to an international bank, so the payment
and receiving methods are fixed server-side (WALLET / BANK) and are never partner-supplied. This
is a dedicated schema carrying only the cross-border routing fields plus the funding basics
(payer_id/user_id, payee_id, amount) and the extra description and invoice_no.
Unique identifier (UUID) of the user funding the payout (payer).
"f47ac10b-****-****-****-0e02b2c3d479"
Unique identifier (UUID) of the payee user.
"f47ac10b-****-****-****-0e02b2c3d479"
Source amount debited from the payer's wallet.
Saved payee bank id (bank details resolved server-side).
Currency paid out.
8"INR"
Optional invoice or transaction reference number for tracking and record-keeping.
20"INV-2024-001234"
Optional short note or description for the payout.
255Response
Successful Response
Indicates whether the request was processed successfully.
true
A short, human-readable message describing the result of the request.
"Operation completed."
The main response payload, if applicable
The Unix timestamp (in seconds) indicating when the response was generated.
1718006400

