Bank Account
The merchant's unique identification number.
Specifies whether the bank account number provided in the request is encrypted. Default: false
falseSpecifies whether to return only the last four digits of the account number. Default: false
falseSpecifies whether to return only active (effective) accounts. Default: true
trueReturns a list of bank accounts successfully.
Bad Request: Returns when merchantNumber null or empty.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: Bank accounts not found.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
The merchant's unique identification number.
Specifies whether the bank account number provided in the request is encrypted. Default: false
falseSpecifies whether to return only the last four digits of the account number. Default: false
falseUnique identifier for the bank account.
43543634Name of the bank associated with the account.
Bank of AmericaThe name on the bank account.
John A. DoeThe first name of the account holder.
JohnThe last name of the account holder.
DoeType of bank account. Possible values: 1 - Checking 2 - Savings
1Name type ID for the bank account.
123The routing number associated with the bank account. In different regions, this may represent BIC (EU) or Sort Code (UK).
Mandatory for US and UK; optional for EU.
091000019The account number associated with the bank account.
123456789The last four digits of the bank account number.
6789Encrypted version of the bank account number.
32652752350******Document ID for the voided check linked to the bank account.
123e4567-e89b-12d3-a456-426614174000Indicates if the account has fees associated with it.
trueIndicates if the account has available funds.
trueIndicates if the account has a history of chargebacks.
falseIndicates if the account name is the same as the legal or DBA name.
trueThe account currency in ISO 4217 code
USDUTC date and time when the account was last updated.
2025-01-27T10:30:00ZCreated a new bank account successfully.
Bad Request: Returns when merchantNumber null or empty.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: Bank accounts not found.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
The merchant's unique identification number.
Specifies whether the bank account number provided in the request is encrypted. Default: false
falseSpecifies whether to return only the last four digits of the account number. Default: false
falseSuccessfully updated a bank account.
Bad Request: Error occurred during save: no merchant number provided or Error occurred during save: no bank account provided or if data is invalid.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: Bank accounts not found.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
The merchant's unique identification number.
The unique identifier of the bank account.
Successfully deleted a bank account.
No content
Bad Request: If merchantNumber is null or empty, or bankAccountId is invalid.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: If resource / bank account not found.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
No content
The merchant's unique identification number.
The unique identifier of the bank account.
Specifies whether the bank account number provided in the request is encrypted. Default: false
falseSpecifies whether to return only the last four digits of the account number. Default: false
falseUnique identifier for the bank account.
43543634Name of the bank associated with the account.
Bank of AmericaThe name on the bank account.
John A. DoeThe first name of the account holder.
JohnThe last name of the account holder.
DoeType of bank account. Possible values: 1 - Checking 2 - Savings
1Name type ID for the bank account.
123The routing number associated with the bank account. In different regions, this may represent BIC (EU) or Sort Code (UK).
Mandatory for US and UK; optional for EU.
091000019The account number associated with the bank account.
123456789The last four digits of the bank account number.
6789Encrypted version of the bank account number.
32652752350******Document ID for the voided check linked to the bank account.
123e4567-e89b-12d3-a456-426614174000Indicates if the account has fees associated with it.
trueIndicates if the account has available funds.
trueIndicates if the account has a history of chargebacks.
falseIndicates if the account name is the same as the legal or DBA name.
trueThe account currency in ISO 4217 code
USDUTC date and time when the account was last updated.
2025-01-27T10:30:00ZSuccessfully updated a bank account.
Error occurred during save: no merchant number provided or Error occurred during save: no bank account provided or if data is invalid.
If bank account not found.
Error occurred during update.
The merchant's unique identification number.
The unique identifier of the bank account.
Successfully deleted a bank account.
No content
Bad Request: If merchantNumber is null or empty, or bankAccountId is invalid.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: If resource / bank account not found.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
No content
Last updated
Was this helpful?