Skip to main content
POST
Submit transaction

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer — a cus_… reference id.

Example:

"cus_3HfG8kLp2QwE7rTy9UiO"

Body

application/json
nameOrAlias
string
required

Your reference for the transaction.

quoteId
string
required

Quote the transaction is priced against.

fundsSource
string
required

Declared source of funds.

endlTransactionMode
string
required

Transfer mode, for example STABLE_COIN_TO_FIAT.

recipientId
string

Recipient being paid — rec_…. Required for every mode except TOP_UP.

transferPurposeCode
string

Purpose-of-transfer code.

walletId
string

The wallet the payout is sent from — wlt_…; the amount and fees are both deducted from it. Required when endlTransactionMode is STABLE_COIN_TO_FIAT, STABLE_COIN_TO_STABLE_COIN or TOP_UP. Use the same wallet as the pre-transaction. Not used for other modes.

transferPurpose
string

Free-text purpose of the transfer.

invoiceFileIdList
string[]

file_… ids from Upload invoice. Required when the purpose code or recipient has invoiceMandatory: true.

Response

The transaction. Unwrapped — 200, not 201.

A transaction, unwrapped. Returned by Submit, Get and (as an array) List — standard and POBO alike. Keys with no value are left out, except inside recipientData and depositData.

txnId
string

txn_… id.

nameOrAlias
string

Label sent at submit. POBO on POBO transactions.

userId
string

cus_… customer. Not returned on POBO.

quoteId
string

qut_… id.

recipientId
string

rec_… id.

depositId
string

dep_… id. Left out when there is no deposit.

sourceAmount
string

Decimal amount, sent as a string.

destinationAmount
string

Decimal amount, sent as a string.

sourceCurrency
string

Currency code.

destinationCurrency
string

Currency code.

sourceChain
string

Chain of the crypto leg. Left out for fiat.

destinationChain
string

Chain of the crypto leg. Left out for fiat.

fxRate
string

Rate applied to the sender, as a string.

transferPurpose
string

As sent at submit.

transferPurposeCode
string

As sent at submit.

fundsSource
string

As sent at submit.

sentOrReceived
string

Sent or Received.

endlTransactionMode
string

STABLE_COIN_TO_FIAT, STABLE_COIN_TO_STABLE_COIN, FIAT_TO_FIAT, FIAT_TO_STABLE_COIN, TOP_UP.

depositRail
string

How it was funded, e.g. CRYPTO, ENDL_ACCOUNT, ACH.

status
string

INITIATED, IN_PROGRESS, IN_REVIEW, COMPLETE, REJECTED, REFUNDED, PENDING_TRAVEL_RULE.

subStatus
string

Finer step, e.g. PENDING_DEPOSIT_CONFIRMATION, PROCESSING_PAYOUT, TRANSACTION_PROCESSED_SUCCESSFULLY, TRANSACTION_REJECTED, TRANSACTION_REFUNDED. The full list is in the Transactions guide.

chargesTotal
string

Fee total, source currency, as a string.

chargesTotalCurrency
string

Equals sourceCurrency.

chargesTotalInSourceCurrency
number

Fee total as a number.

chargesTotalInSourceCurrencyActual
number

Fee total as a number.

chargeTotalUSDActual
number

Fee total in USD, as a number.

chargesData
object[]

Fee lines.

recipientData
object

Snapshot of the recipient at submit: name, email, address (10 keys), bank fields, recipientType, payoutRail, walletAddress. All keys present.

depositData
object

Funding deposit: depositRail, status (INITIATED, PENDING, COMPLETE, REJECTED), amounts and currencies requested and received, chainCode, depositAddress, chainScanLink, confirmationId, updatedOn, and more. Left out when there is no deposit.

txHash
string

On-chain hash of the crypto leg. Appears once it settles.

invoiceData
object[]

{ invoiceFileId, fileName, invoiceFileUrl } per attached invoice. invoiceFileUrl is a short-lived signed link.

deposit
boolean

Always false on a transaction.

test
boolean

Sandbox marker.

createdOn
string

ISO 8601.

updatedOn
string

ISO 8601.