Authorizations
API token authentication using format <api token id>:<api client secret>
Path Parameters
ID of the quote to retry
Body
Unique identifier for the prior receiver uma address lookup request.
"Lookup:019542f5-b3e7-1d02-0000-000000000009"
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/{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
Quote created successfully. The response includes payment instructions that the client can use to execute the payment through their banking provider.
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.