6. Buyer Bank Account
5.1 Overview
Buyer Bank Account: These are the bank accounts that have been added for the buyer. The buyer can add any number of Bank Accounts but the same bank account information cannot be added twice.
5.2 Attributes
Field | Sub-field | Type | Description |
---|---|---|---|
id | string | ID of bank account assigned by CPX | |
accountType | enum | Type of Bank account
| |
accountNumber | string | Bank account number | |
routingNumber | string | Bank routing number | |
defaults | object | The bank account is to be set as the default account for which payment methods
| |
bankName | String | Name of bank to which the bank account belongs | |
recordCount | Integer | Total count of records fetched | |
records | Array of objects | Array of all the records fetched | |
totalRecords | Integer | Total count of records existing | |
bankAccountId | String | Id of bank account | |
billing | String(Enum) | Type of billing set up for the buyer
| |
debitMethod | String(Enum) | Debit method selected for the buyer
| |
checkStartNumber | Integer | Starting number for the checks to be printed for the buyer | |
checkNextNumber | Integer | Next number for the checks to be printed for the buyer | |
address | Object | Address details for the buyer | |
street1 | String | Street address | |
city | String | City of buyer | |
state | String | State of buyer | |
postalCode | String | Postal code of buyer | |
accountStatus | String(Enum) | Status of the check account | |
buyerId | String | Id of buyer to which account is associated | |
buyerName | String | Name of buyer to which account is associated | |
associatedInstitutionId | String | Id of institution to which buyer to which account is associated | |
fileName | String | Name of signature file to be associated and printed on check | |
file | String | Signature File in base64 encoded format to be printed on check | |
signatureAttachmentId | String | Id of the attachment for signature image | |
deposit1 | String | Amount 1 of microdeposit for account verification | |
deposit2 | String | Amount 2 of microdeposit for account verification | |
checkProofId | String | Id of check proof image generated by Smart Payables | |
passportBankAccountStatus | String | Status of Bank account on Passport |
5.3 Operations
5.3.1. Create Bank account for a Buyer
5.3.2. Retrieve Bank account by Token
5.3.3. Retrieve all Bank accounts for a Buyer
5.3.4. DELETE Bank Account
5.3.5. Update default Bank account for a Buyer product
5.3.5. GET default Bank account for a Buyer product
5.3.6. Create Check Account for Buyer
5.3.7. GET Check account for a Buyer by Token
5.3.8. Delete Check account for a Buyer by Token
5.3.9. Update Check account for a Buyer by Token
5.3.10. Assign Signature
5.3.11. Confirm Check Account
5.3.12. Verify Microdeposit
5.3.13. Approve Check Proof for a Check Account
5.3.14. Reject Check Proof for a Check Account
5.3.15. Retrieve Check Proof for a Check Account
5.3.16. Activate Check Account
5.3.17. Deactivate Check Account
5.3.18. Update Critical Check Account Info
5.3.19. Create Check Account for Managed Check
5.3.20. Confirm Check Account
5.3.21. Verify Micro deposit for Check Account for Managed Check
Updated 3 days ago