Create a transfer-out request
Transfer funds from an internal account to an external account for a specific customer.
Authorizations
API token authentication using format <api token id>:<api client secret>
Headers
A unique identifier for the request. If the same key is sent multiple times, the server will return the same response as the first request.
"550e8400-e29b-41d4-a716-446655440000"
Body
Response
Transfer-out request created successfully
- Incoming Transaction
- Outgoing Transaction
Unique identifier for the transaction
"Transaction:019542f5-b3e7-1d02-0000-000000000004"
Status of a payment transaction.
CREATED, PENDING, PROCESSING, COMPLETED, REJECTED, FAILED, REFUNDED, EXPIRED Type of transaction (incoming payment or outgoing payment)
INCOMING Destination account details
- Account Destination
- UMA Address Destination
System ID of the customer (sender for outgoing, recipient for incoming)
"Customer:019542f5-b3e7-1d02-0000-000000000001"
Platform-specific ID of the customer (sender for outgoing, recipient for incoming)
"18d3e5f7b4a9c2"
Amount received in the recipient's currency
When the payment was or will be settled
"2025-08-15T14:30:00Z"
When the transaction was created
"2025-08-15T14:25:18Z"
When the transaction was last updated
"2025-08-15T14:30:00Z"
Optional memo or description for the payment
"Payment for invoice #1234"
Additional information about the counterparty, if available and relevant to the transaction and platform.
Source account details
- Account Source
- UMA Address Source
- Real-time Funding Source
Included for all transactions except those with "CREATED" status
Details about the rate and fees for the transaction.
If the transaction failed, this field provides the reason for failure.
LNURLP_FAILED, PAY_REQUEST_FAILED, PAYMENT_APPROVAL_WEBHOOK_ERROR, PAYMENT_APPROVAL_TIMED_OUT, OFFRAMP_FAILED, MISSING_MANDATORY_PAYEE_DATA, QUOTE_EXPIRED, QUOTE_EXECUTION_FAILED