Simulate sending funds

Simulate sending funds to the bank account as instructed in the quote. This endpoint is only for the sandbox environment and will fail for production platforms/keys.

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Body

application/json

reference · string · required

The unique reference code that was in the payment instructions

Example:

"UMA-Q12345-REF"

currencyCode · string · required

Currency code for the funds to be sent

Example:

"USD"

currencyAmount · integer · required

The amount to send in the smallest unit of the currency (eg. cents)

Required range: x > 0

Example:

1000

Response

200

application/json

Funds received successfully

id · string · required

Unique identifier for the transaction

Example:

"Transaction:019542f5-b3e7-1d02-0000-000000000004"

status · enum<string> · required

Status of a payment transaction

Available options:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

REJECTED,

FAILED,

REFUNDED,

EXPIRED

type · enum<string> · required

Type of transaction (incoming payment or outgoing payment)

Available options:

INCOMING,

OUTGOING

source · object · required

Source account details

Account Source

Show child attributes

destination · object · required

Destination account details

Account Destination

Show child attributes

customerId · string · required

System ID of the customer (sender for outgoing, recipient for incoming)

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

platformCustomerId · string · required

Platform-specific ID of the customer (sender for outgoing, recipient for incoming)

Example:

"18d3e5f7b4a9c2"

sentAmount · object · required

Amount sent in the sender's currency

Show child attributes

paymentInstructions · object[] · required

Payment instructions for executing the payment.

Show child attributes

Example:

[
  {
    "accountType": "US_ACCOUNT",
    "accountNumber": "1234567890",
    "routingNumber": "021000021",
    "bankName": "Chase Bank",
    "referenceCode": "REF123456"
  },
  {
    "accountType": "SPARK_WALLET",
    "address": "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu",
    "invoice": "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
  }
]

settledAt · string<date-time>

When the payment was or will be settled

Example:

"2025-08-15T14:30:00Z"

createdAt · string<date-time>

When the transaction was created

Example:

"2025-08-15T14:25:18Z"

updatedAt · string<date-time>

When the transaction was last updated

Example:

"2025-08-15T14:30:00Z"

description · string

Optional memo or description for the payment

Example:

"Payment for invoice #1234"

counterpartyInformation · object

Additional information about the counterparty, if available and relevant to the transaction and platform. Only applicable for transactions to/from UMA addresses.

Example:

{
  "FULL_NAME": "John Sender",
  "BIRTH_DATE": "1985-06-15",
  "NATIONALITY": "DE"
}

receivedAmount · object

Amount to be received by recipient in the recipient's currency

Show child attributes

exchangeRate · number

Number of sending currency units per receiving currency unit.

Required range: x > 0

Example:

1.08

fees · integer

The fees associated with the quote in the smallest unit of the sending currency (eg. cents).

Required range: x >= 0

Example:

10

quoteId · string

The ID of the quote that was used to trigger this payment

Example:

"Quote:019542f5-b3e7-1d02-0000-000000000006"

originalTransactionId · string

ID of the original transaction that this transaction is retrying, if applicable

Example:

"Transaction:019542f5-b3e7-1d02-0000-000000000003"

refund · object

The refund if transaction was refunded.

Show child attributes

rateDetails · object

Details about the rate and fees for the transaction.

Show child attributes

failureReason · enum<string>

If the transaction failed, this field provides the reason for failure.

Available options:

QUOTE_EXPIRED,

QUOTE_EXECUTION_FAILED,

LIGHTNING_PAYMENT_FAILED,

FUNDING_AMOUNT_MISMATCH,

COUNTERPARTY_POST_TX_FAILED,

TIMEOUT