Create Transfer

Creates a transfer.

State

StateDescription
storingThe Platform is storing the trade details in our private store
reviewingThe Platform is reviewing the transfer for compliance
pendingThe Platform is executing the transfer
completedThe Platform has successfully completed the transfer
failedThe Platform was not able to successfully complete the transfer

Failure codes

CodeDescription
amount_too_lowThe transfer was rejected due to the amount being too low
cancelledThe transfer was manually cancelled
compliance_rejectionThe transfer was rejected for compliance reasons
internal_errorAn internal error occurred while processing the transfer, please try again
invalid_addressThe destination address is invalid for transfer
invalid_balanceThere was insufficient balance at the lightning provider to complete the transfer
limit_exceededThe customer is over the limits that have been set for them for this activity
network_fee_too_lowThe transfer was rejected due to the network fee being too low
non_sufficient_fundsThe customer does not have enough funds to complete the transfer
party_name_invalidThe transfer's associated external bank account has an invalid party name
payment_rail_invalidThe payment rail specified for the transfer is not supported by the external bank account
plaid_access_not_grantedSee the description from Plaid here
plaid_institution_not_respondingSee the description from Plaid here
plaid_internal_server_errorSee the description from Plaid here
plaid_item_not_foundSee the description from Plaid here
plaid_item_not_supportedSee the description from Plaid here
plaid_multiple_accountsMultiple accounts were selected through Plaid Link.
plaid_no_accountsSee the description from Plaid here
plaid_none_balances_errorThe transfer was rejected due to an error with the balances retrieved by Plaid
plaid_unknown_errorSee the description from Plaid here
refresh_requiredThe transfer's associated external_bank_account needs to be reconnected via Plaid
reversedThe transfer was reversed

Failure codes that will result in a state change for the associated external bank account

CodeDescription
refresh_requiredThe transfer was rejected due to the external bank account needing to be refreshed. The external bank account will be put in the state refresh_required
plaid_access_not_grantedThe transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state deleted
plaid_item_not_foundThe transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state deleted
plaid_item_not_supportedThe transfer was rejected because the account is not supported. A different account should be connected via Plaid. The external bank account will be put in the state deleted
plaid_multiple_accountsThe transfer was rejected because multiple accounts were selected through Plaid Link. Only one account must be selected. The external bank account will be put in the state deleted
plaid_no_accountsThe transfer was rejected because no compatible accounts could be found. The external bank account will be put in the state deleted

Required scope: transfers:execute

Language
Credentials
URL
Click Try It! to start a request and see the response here!