Transfers
Overview
The Transfers module of the Customer API facilitates the movement of funds and manages transfer-related operations with a suite of endpoints tailored to cover various functionalities:
Create Internal Fiat Transfer: This endpoint allows customers to conduct internal fund transfers between two customer asset accounts within the system. The users need to specify the source and destination account IDs, the amount to be transferred, and a reference note for the transaction.
Create External Fiat Transfer: Customers can perform external transfers from their asset account using this endpoint. It supports both domestic and international transfers, requiring information about the source account, transfer type, payee details, saved payee preferences, amount, reference note, and the purpose code for the transaction.
Create External Fiat Transfer With Originator: Customers can perform external transfers from their asset account using this endpoint. User's have the ability to set the transaction's originator, and thus affect how the sender's details appear in the receiver's account. It supports both domestic and international transfers, requiring information about the source account, transfer type, payee details, saved payee preferences, amount, reference note, and the purpose code for the transaction.
Get Purpose Codes: This endpoint provides a list of available purpose codes that are to be used for external fiat transfers. It helps in categorizing the transfer types for internal use, such as "Transfer to own account" or "Family Maintenance".
Create Internal Crypto Transfer: This endpoint allows customers to conduct internal cryptocurrency transfers between two customer asset accounts within the system. The users need to specify the source and destination account IDs, the amount to be transferred.
Create Internal Fiat Transfer
Make an internal fiat transfer between two customer asset accounts
Example Request Body
Example Success Response
Create External Fiat Transfer
Make an external transfer from a customer asset account, using either a Wire or ACH. Refer to Purpose Codes to categorize a transfer.
Payee Request Parameters
When configuring a payee, you can either use payeesId
to use an existing payee, or provide payee information directly. Additionally, you can refer to the Payees API Endpoints to access various functionality such as creating, retrieving, modifying, and deleting payees.
Example Request Body
The format of the request body is different between Domestic USA transfers and international transfers. Refer to the following examples for reference:
Domestic Wire Transfer Request Body
International Wire Transfer Request Body
Example Success Response
Create External Fiat Transfer With Originator
Make an external transfer with a user defined originator from a customer asset account, using either a Wire or ACH. Refer to Purpose Codes to categorize a transfer.
Payee Request Parameters
When configuring a payee, you can either use payeesId
to use an existing payee, or provide payee information directly. Additionally, you can refer to the Payees API Endpoints to access various functionality such as creating, retrieving, modifying, and deleting payees.
Originator Request Parameters
The settable parameters for the originator depend on whether the transfer is a Wire or an ACH transfer.
Example Request Body
The format of the request body is different between Domestic USA transfers and international transfers. Refer to the following examples for reference:
Domestic Wire Transfer Request Body
International Wire Transfer Request Body
Example Success Response
Get Purpose Codes
Get list of available purpose codes to be used for external fiat transfer.
Example Success Response
Create Internal Crypto Transfer
This endpoint initiates a transfer of crypto currency between two asset accounts that are accessible by a manager. The endpoint requires parameters for the source account ID, the destination account ID, and the amount for the transfer. The asset to be transferred is inferred by the asset account ID.
Endpoint:
/api/v1/customer/accounts/crypto/move
Method:
POST
Request Body Example
Response Body Example
Last updated