Sign in
Internal Transfers

Make Internal Transfer

Make an internal transfer between accounts of the same family of companies. An internal transfer can have the following statuses:

  • PENDING: The transfer has been created.
  • PROCESSING: The transfer has started to be processed and funds have been debited.
  • SETTLING: The transfer is being settled.
  • COMPLETED: The funds have been sent to the destination account (but not necessarily received yet).
  • FAILED: The transfer failed.
post/internal-transfer/

Headers

x-company-idinteger

ID of a child company for authentication. If not provided, the parent company will be authenticated.

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Request body

idempotency_keystring

A unique key that ensures a request is processed only once. If the same key is sent with multiple requests, the server returns the original response instead of performing the action again.

source_account_idstring required

Source account ID

target_account_idstring required

Target account ID

source_amountnumber

Amount to transfer from source to target account (in source account currency). If not provided, the target_amount must be provided

target_amountnumber

Amount to receive in the target account currency (in target account currency). If not provided, the source_amount must be provided

quote_idstring

Quote request ID to use a previously obtained quote. If not provided, the current rate will be used and accepted

callback_urlstring

URL to send a POST request with the result of the transfer. The schema of the POST request is the same as the response of this endpoint

Response

Successful Response

status'success'

Changes

No recorded changes to this endpoint across all 1 revision of this API.