Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Body

application/json
onBehalfOf
string
required

Primary customer ID (on whose behalf the transfer is made)

Example:

"cus_abc123"

source
object
required

Source payment details

destination
object
required

Destination payment details

amount
object
required
paymentReason
enum<string>
required

Reason for the payment (compliance/AML).

Available options:
CAPITAL_CONTRIBUTIONS,
CHARITABLE_CONTRIBUTIONS,
CONSULTING_FEES,
CORPORATE_TAX_PAYMENTS,
DOWN_PAYMENTS_FOR_REAL_ESTATE,
EDUCATION_FEES,
EMPLOYEE_SALARIES_OR_WAGES,
EXPENSES_REIMBURSEMENT,
GIFTS,
GOVERNMENT_GRANTS,
INCOME_TAX_PAYMENTS,
INHERITANCE_PAYMENTS,
INSURANCE_CLAIM_PAYOUTS,
INSURANCE_PREMIUM_PAYMENTS,
INVESTMENTS,
LOAN_ADVANCES,
MORTGAGE_PAYMENTS,
OTHER,
PAYMENT_FOR_GOODS_AND_SERVICES,
PERSONAL_TRANSFERS,
REAL_ESTATE_PURCHASES,
REMITTANCES,
RENT,
REPAYMENT_OF_LOANS,
ROYALTIES,
SELF,
TRADE_SETTLEMENT,
TRUST_FUND_DISTRIBUTIONS,
UTILITY_BILLS,
WELFARE_OR_BENEFITS,
WINNINGS_AND_PRIZES
clientReferenceId
string

Client's internal reference ID (e.g., order ID, transaction ID)

Maximum string length: 256
Example:

"order_abc123"

counterpartyId
string

Counterparty ID for third-party recipient transfers. Omit for first-party transfers.

Example:

"cp_abc123"

remarks
string

Free-form remarks or notes about the transfer (e.g., invoice discrepancy explanations)

Maximum string length: 1000
Example:

"Partial payment - remaining balance to be paid next month"

internalRemarks
string

Internal remarks visible only within your organization. Never forwarded to payment rails (SWIFT, ACH, etc.) or counterparties.

Maximum string length: 1000
Example:

"Approved by ops on 2026-04-15"

developerFeeFixed
number

Fixed developer fee in minor units of source currency. Added on top of provider fees and deducted from the transfer amount.

Example:

100

developerFeePercent
number

Developer fee as decimal percentage (e.g., 0.015 for 1.5%). Deducted from the transfer amount before sending to the destination. Maximum 0.1 (10%).

Required range: x <= 0.1
Example:

0.015

documentIds
string[]

Supporting document IDs for the transfer. Required for third-party SWIFT payments (when the destination account is marked as third-party or the destination customer differs from the originating customer).

Example:
expiresAt
string<date-time>

Optional transfer expiration timestamp. If omitted, the transfer expires 7 days after creation when funded by a fiat pay-in (wire/ACH) and 48 hours after creation otherwise.

Example:

"2026-12-31T23:59:59Z"

requiresAuthorization
boolean
default:false

If true, this payment must be authorized before it is processed. Attach the supporting invoice via documentIds. The transfer parks in PENDING_AUTHORIZATION and does not move funds until it is approved.

lock
boolean

Persist a firm quote that can be confirmed. Preview quotes omit this.

Example:

false

Response

Transfer intent quoted successfully.

sourceAmount
object
required
destinationAmount
object
required
exchangeRate
string
required

All-in exchange rate.

Example:

"0.99985"

fees
object
required
expiresAt
string<date-time>
required

When the quote expires.

supported
boolean
required

Whether this intent can be confirmed.

Example:

true

lockable
boolean
required

Whether a firm quote can be locked before confirm. Non-lockable corridors confirm from the intent body.

Example:

true

confirmationReference
string

Opaque reference used to confirm a locked quote. Omitted for indicative previews.

Example:

"quote_abc123"

destinationPaymentRail
string

Payout rail this quote will execute. A fixed route can end on a different rail than the one requested.

Example:

"SEPA"

estimate
object

Estimated transfer timing when available.

minimumAmount
object

Minimum amount for this route when known.