post https://bank.sandbox.cybrid.app/api/transfers
Creates a transfer.
State
State | Description |
---|---|
storing | The Platform is storing the trade details in our private store |
reviewing | The Platform is reviewing the transfer for compliance |
pending | The Platform is executing the transfer |
completed | The Platform has successfully completed the transfer |
failed | The Platform was not able to successfully complete the transfer |
Failure codes
Code | Description |
---|---|
amount_too_low | The transfer was rejected due to the amount being too low |
cancelled | The transfer was manually cancelled |
compliance_rejection | The transfer was rejected for compliance reasons |
internal_error | An internal error occurred while processing the transfer, please try again |
invalid_address | The destination address is invalid for transfer |
invalid_balance | There was insufficient balance at the lightning provider to complete the transfer |
limit_exceeded | The customer is over the limits that have been set for them for this activity |
network_fee_too_low | The transfer was rejected due to the network fee being too low |
non_sufficient_funds | The customer does not have enough funds to complete the transfer |
party_name_invalid | The transfer's associated external bank account has an invalid party name |
payment_rail_invalid | The payment rail specified for the transfer is not supported by the external bank account |
plaid_access_not_granted | See the description from Plaid here |
plaid_institution_not_responding | See the description from Plaid here |
plaid_internal_server_error | See the description from Plaid here |
plaid_item_not_found | See the description from Plaid here |
plaid_item_not_supported | See the description from Plaid here |
plaid_multiple_accounts | Multiple accounts were selected through Plaid Link. |
plaid_no_accounts | See the description from Plaid here |
plaid_none_balances_error | The transfer was rejected due to an error with the balances retrieved by Plaid |
plaid_unknown_error | See the description from Plaid here |
refresh_required | The transfer's associated external_bank_account needs to be reconnected via Plaid |
reversed | The transfer was reversed |
Failure codes that will result in a state change for the associated external bank account
Code | Description |
---|---|
refresh_required | The 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_granted | The 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_found | The 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_supported | The 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_accounts | The 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_accounts | The 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