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.
Get Reverse Inbound Transfer Details - This operation gives a user necessary details to call the POST endpoint. This includes a list of reasons for transaction reversal.
Reverse Inbound Transfer - This operation allows the user to reverse an inbound external transfer.
Lookup Bank Details: This endpoint allows customers to look up additional bank details given a SWIFT code (more lookup options coming soon).
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.
Endpoint:
/api/v3/customer/transfers/fiat/createexternaltransfer
Method:
POST
Transfer Types
Create External Fiat Transfer currently supports four different TransferTypes
. Depending on your account type, you can access the following:
Wire
- FedWire, available to US accounts.ACH
- Available to US accounts.RTP
- Realtime Domestic US Payments, also known as FedNow. Available to US accounts.SWIFT
- For international accounts.P2C
- Use only withPayeesId
set to a card-type payee.
Request Body Parameters
transmitter
Object, Required for Financial Institutions
Information relating to the transmittere of payment
transmitter.firstPartyTransfer
Boolean
True if the payment is a first party transfer. If true, other transmitter fields are not required.
transmitter.type
String
'Company' or 'Individual'
transmitter.dateOfBirth
datetime
If Transmitter type is 'Individual', date of birth is required
transmitter.name
String
Name of Transmitter
transmitter.accountNumber
String, Optional
Account Number for the Transmitter
transmitter.addressLine1
String
Address Line 1 for transmitter
transmitter.addressLine2
String, Optional
Address Line 2 for transmitter
transmitter.townCity
String
Town / City for transmitter
transmitter.state
String
State / Province for transmitter
transmitter.postcode
String
Post Code for transmitter
transmitter.countryCode
String
3 Letter Country Code for transmitter (ex. USA)
payee
Object, Required
Payee / Beneficary information
payee.payeesId
Number
Optional Payees ID of an existing payee, for sending payments to an existing payee. If provided, the other payee fields are not required.
payee.name
String
Name of Payee
payee.type
String
'Personal' or 'Company'
payee.countryCode
String
3 Letter Country Code for recieving bank (ex. USA)
payee.bankName
String
Name of Receiving Bank
payee.routingNumber
String
ABA Routing Number, not required if swiftCode is provided
payee.swiftCode
String
SWIFT Bic, not required if routingNumber is provided
payee.intermediarySwiftCode
String, Optional
Optional Intermediary Bank SWIFT Bic. Only available for SWIFT transfers.
payee.accountNumber
String
Account Number of payee
payee.accountName
String
Name of the payee's account. If unknown, use the payee name
payee.addressLine1
String
Address Line 1 for payee
payee.addressLine2
String, Optional
Address Line 2 for payee
payee.townCity
String
Town / City for payee
payee.state
String
State / Province for payee
payee.postcode
String
Post Code for payee
payee.addressCountryCode
String
3 Letter Country Code for payee (ex. USA)
bSavePayee
Boolean
True if you would like to save the payee details for future use
sourceAccountId
Number
Account ID corresponding to the account to be debited
transferType
String
Transfer rail (ex. 'SWIFT', 'Wire', etc)
amount
Number
Amount to be sent. The currency is implied by the currency of the sourceAccountId
bankFeeSplitType
String
For SWIFT transfers only, specify 'Full Bank Fee', 'Half Bank Fee', or 'No Bank Fee'. If none is provided, default is 'Half Bank Fee'
reference
String
Reference message to be sent to the receiving bank. (Limit 140 characters)
purposeCode
String, Enum
purpose
String
If a purposeCode is not provided, you may use purpose, which is a string to specify the purpose of the payment (max 100 chars). You must provide either purpose or purposeCode, however purposeCode is required for Wire transfers sent to payees outside the USA
Transfer Purpose
External fiat transfers may require a payment purpose to be submitted in the request body. A list of applicable payment purpose codes for a particular transfer is returned from the Purpose Codes endpoint. If the purposeCode
is omitted or specified as 'Other', then you should submit a customer purpose in the purpose
field.
Note: When a purpose code is required, it will be listed in the Purpose Codes endpoint. If no purpose codes are returned from this endpoint, then purposeCode
is not required and you should specify the purpose of the payment in purpose
.
PurposeCode
String
Purpose
String
Provide a string for purpose reason. Limit 100 chars. [a-z], [A-Z], [0-9]
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.
Transmitter Information
Financial Institutions are required to submit information regarding the transmitter of a payment. You can submit this information in the transmitter object. For transactions that are first party transfer, you can specify firstPartyTransfer: true
Third Party Payment Example
First Party Payment Example
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 Swift Transfer Request Body
International transfers utilize the SWIFT
TransferType. Customers can specify the BankFeeSplitType
, which enables a customer to decide the bearer of bank charges. You can choose between the following values for BankFeeSplitType
:
"Full Bank Fee"
- This option is known as 'OURS'"Half Bank Fee"
- This option is known as 'SHA'"No Bank Fee"
- This option is known as 'BEN'
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.
Transfer Types
Create External Fiat Transfer currently supports four different TransferTypes
. Depending on your account type, you can access the following:
Wire
- FedWire, available to US accounts.ACH
- Available to US accounts.RTP
- Realtime Domestic US Payments, also known as FedNow. Available to US accounts.SWIFT
- For international accounts.P2C
- Use only withPayeesId
set to a card-type payee.
Request Body Parameters
transmitter
Object, Required for Financial Institutions
Information relating to the transmittere of payment
transmitter.firstPartyTransfer
Boolean
True if the payment is a first party transfer. If true, other transmitter fields are not required.
transmitter.name
String
Name of Transmitter
transmitter.accountNumber
String, Optional
Account Number for the Transmitter
transmitter.addressLine1
String
Address Line 1 for transmitter
transmitter.addressLine2
String, Optional
Address Line 2 for transmitter
transmitter.townCity
String
Town / City for transmitter
transmitter.state
String
State / Province for transmitter
transmitter.postcode
String
Post Code for transmitter
transmitter.countryCode
String
3 Letter Country Code for transmitter (ex. USA)
payee
Object, Required
Payee / Beneficary information
payee.payeesId
Number
Optional Payees ID of an existing payee, for sending payments to an existing payee. If provided, the other payee fields are not required.
payee.name
String
Name of Payee
payee.type
String
'Personal' or 'Company'
payee.countryCode
String
3 Letter Country Code for recieving bank (ex. USA)
payee.bankName
String
Name of Receiving Bank
payee.routingNumber
String
ABA Routing Number, not required if swiftCode is provided
payee.swiftCode
String
SWIFT Bic, not required if routingNumber is provided
payee.intermediarySwiftCode
String, Optional
Optional Intermediary Bank SWIFT Bic. Only available for SWIFT transfers.
payee.accountNumber
String
Account Number of payee
payee.accountName
String
Name of the payee's account. If unknown, use the payee name
payee.addressLine1
String
Address Line 1 for payee
payee.addressLine2
String, Optional
Address Line 2 for payee
payee.townCity
String
Town / City for payee
payee.state
String
State / Province for payee
payee.postcode
String
Post Code for payee
payee.addressCountryCode
String
3 Letter Country Code for payee (ex. USA)
bSavePayee
Boolean
True if you would like to save the payee details for future use
originator
Object
Information relating to the originator
originator.companyId
String
Company ID of the originator
originator.name
String
Name of Orignator
originator.AddressLine1
String
Address line 1 for originator
originator.AddressLine2
String
Address line 2 for originator
originator.AddressLine3
String
Address line 3 for originator
originator.Data
String
Additional data to be sent with Originator Information
sourceAccountId
Number
Account ID corresponding to the account to be debited
transferType
String
Transfer rail (ex. 'SWIFT', 'Wire', etc)
amount
Number
Amount to be sent. The currency is implied by the currency of the sourceAccountId
bankFeeSplitType
String
For SWIFT transfers only, specify 'Full Bank Fee', 'Half Bank Fee', or 'No Bank Fee'. If none is provided, default is 'Half Bank Fee'
reference
String
Reference message to be sent to the receiving bank. (Limit 140 characters)
purposeCode
String, Enum
purpose
String
If a purpose code is not required, you should specify the purpose of the payment here (max 100 chars). If the purpose code corresponding to 'Other' is used, then the custom purpose must be provided here.
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.
Transmitter Information
Financial Institutions are required to submit information regarding the transmitter of a payment. You can submit this information in the transmitter object.
Third Party Payment Example
First Party Payment Example
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
Query Parameters
customerAssetAccountsId
(Integer) - The ID of the source account making the external fiat transfer (REQUIRED),payeesId
(Integer) - The ID of the payee in the external fiat transfer. Required ifcountryCode
is not specified, optional otherwise.countryCode
(String) - The country code of the payee in ISO/ISO2 format. Required ifpayeesId
is not specified, optional otherwise.
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
Get Reverse Inbound Transfer Details
This operation gives the user necessary details to call the POST endpoint to reverse an inbound transfer.
Endpoint:
/api/v1/customer/accounts/reverse-inbound-transfer
Method: GET
Query Parameters:
customersId
(Integer): The ID of the customer account from which the withdrawal is to be made.
Response Body Parameters:
id
(Integer): A reference ID for the transaction; not used in the example.details.purposes
(JSON Array): List of possible purposes for reversal.details.purposes.id
(Integer): The ID of the purpose.details.purposes.name
(String): Description of the purpose.
Success Response Example:
Reverse Inbound Transfer
This operation allows the user to reverse an inbound transfer.
Endpoint:
/api/v1/customer/accounts/reverse-inbound-transfer
Method: POST
Request Body Parameters:
customersId
(Integer): The ID of the customer account from which the withdrawal is to be made.
Request Example:
Response Body Parameters:
id
(Integer): A reference ID for the transaction; not used in the example.details.transactionId
(JSON Array): Id of the transaction being reversed.
Success Response Example:
Lookup Bank Details
This endpoint allows customers to look up additional bank details given a SWIFT code (more lookup options coming soon).
Last updated