Authorizations
API token authentication using format <api token id>:<api client secret>
Body
Source account details
- Account
- Real-time funding
Destination account details
- Account
- UMA Address
- External Account Details
The side of the quote which should be locked and specified in the lockedCurrencyAmount
. For example, if I want to send exactly $5 MXN from my wallet, I would set this to "sending", and the lockedCurrencyAmount
to 500 (in cents). If I want the receiver to receive exactly $10 USD, I would set this to "receiving" and the lockedCurrencyAmount
to 10000 (in cents).
SENDING
, RECEIVING
The amount to send/receive in the smallest unit of the locked currency (eg. cents). See lockedCurrencySide
for more information.
0 < x <= 9000000000000000
1000
Lookup ID from a previous receiver lookup request. If provided, this can make the quote creation more efficient by reusing cached lookup data.
NOTE: This is required for UMA destinations due to counterparty institution requirements. See senderCustomerInfo
for more information.
"Lookup:019542f5-b3e7-1d02-0000-000000000009"
Whether to immediately execute the quote after creation. If true, the quote will be executed and the transaction will be created at the current exchange rate. It should only be used if you don't want to lock and view rate details before executing the quote. If you are executing a pre-existing quote, use the /quotes/{quoteId}/execute
endpoint instead. This is false by default.
false
Optional description/memo for the transfer
"Invoice #1234 payment"
Only relevant for UMA destinations.
Key-value pairs of information about the sender which was requested by the counterparty (recipient) institution.
Any fields specified in requiredPayerDataFields
from the response of the /receiver/uma/{receiverUmaAddress}
(lookupUma) endpoint
MUST be provided here if they were requested. If the counterparty (recipient) institution did not request any information, this field can be omitted.
{
"FULL_NAME": "Jane Receiver",
"NATIONALITY": "FR"
}
Response
Transfer quote created successfully. The response includes exchange rates, fees, and transfer details. For transfers involving UMA addresses, payment instructions are also included for execution through banking systems.
Unique identifier for this quote
"Quote:019542f5-b3e7-1d02-0000-000000000006"
Current status of the quote
PENDING
, PROCESSING
, COMPLETED
, FAILED
, EXPIRED
"PENDING"
When this quote was created
"2025-10-03T12:00:00Z"
When this quote expires (typically 1-5 minutes after creation)
"2025-10-03T12:05:00Z"
Source account details
- Account
- Real-time funding
Destination account details
- Account Destination
- UMA Address Destination
Currency for the sending amount
Currency for the receiving amount
The total amount that will be sent in the smallest unit of the sending currency (eg. cents).
x > 0
123010
The total amount that will be received in the smallest unit of the receiving currency (eg. cents).
x > 0
1000
Number of sending currency units per receiving currency unit.
x > 0
The fees associated with the quote in the smallest unit of the sending currency (eg. cents).
x >= 0
10
The ID of the transaction created from this quote.
"Transaction:019542f5-b3e7-1d02-0000-000000000005"
Payment instructions for executing the payment. This is not required when using an internal account source.
[
{
"accountType": "US_ACCOUNT",
"accountNumber": "1234567890",
"routingNumber": "021000021",
"bankName": "Chase Bank",
"referenceCode": "REF123456"
},
{
"accountType": "SPARK_WALLET",
"address": "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu",
"invoice": "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
}
]
ID of the quote that is being retried
"Quote:019542f5-b3e7-1d02-0000-000000000001"
Details about the rate and fees for the transaction.