v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Instant Funding

Create an instant funding request

Creates an instant funding request. The request will be processed and the funds will be made available to the account in the form of a Memopost non trade activity. Upon settlement the Memoposted will be corrected to a CSD activity.

Idempotency: When the Idempotency-Key header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one transfer. A subsequent request returns the previously created transfer with the same response (no duplicate is created). If the same key is used with a different request body, the API returns 422 Unprocessable Entity.

Recommended for production: Always supply Idempotency-Key when creating transfers. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate transfers. Use a client-generated unique value (e.g. UUID).

post/v1/instant_funding

Headers

Idempotency-Keystring

Unique key for idempotent create. When supplied, duplicate requests (same key and body) return the original transfer instead of creating a new one. Use a client-generated value (e.g. UUID) per logical transfer. Strongly recommended for production to prevent duplicate transfers on retries.

Request body

account_nostring required
amountstring decimal required
source_account_nostring required

Response

Instant transfer request created.

account_nostring required
amountstring decimal required
created_atstring date-time required
deadlinestring date required
idstring uuid required
remaining_payablestring decimal required
source_account_nostring required
status'PENDING' | 'CANCELED' | 'EXECUTED' | 'FAILED' | 'COMPLETED' required

Status:

  • PENDING: Created and waiting to be processed
  • CANCELED: Canceled
  • EXECUTED: All fees (including Partner fee) are transacted
  • FAILED: Failed mostly due to technical reasons
  • COMPLETED: All transactions are settled
system_datestring date required
total_intereststring decimal required