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

FieldSub-fieldTypeDescription
idstringID of bank account assigned by CPX
accountTypeenumType of Bank account
  • 1. checking
  • 2. savings
accountNumberstringBank account number
routingNumberstringBank routing number
defaultsobjectThe bank account is to be set as the default account for which payment methods
  • ACH
  • CHK
  • MCK
  • VCN
bankNameStringName of bank to which the bank account belongs
recordCountIntegerTotal count of records fetched
recordsArray of objectsArray of all the records fetched
totalRecordsIntegerTotal count of records existing
bankAccountIdStringId of bank account
billingString(Enum)Type of billing set up for the buyer
  • GOOD_FUNDS
  • PREFUND
  • CREDIT
debitMethodString(Enum)Debit method selected for the buyer
  • Debit for Each Transaction
  • Debit by Batch
  • Debit by Day
checkStartNumberIntegerStarting number for the checks to be printed for the buyer
checkNextNumberIntegerNext number for the checks to be printed for the buyer
addressObjectAddress details for the buyer
street1StringStreet address
cityStringCity of buyer
stateStringState of buyer
postalCodeStringPostal code of buyer
accountStatusString(Enum)Status of the check account
buyerIdStringId of buyer to which account is associated
buyerNameStringName of buyer to which account is associated
associatedInstitutionIdStringId of institution to which buyer to which account is associated
fileNameStringName of signature file to be associated and printed on check
fileStringSignature File in base64 encoded format to be printed on check
signatureAttachmentIdStringId of the attachment for signature image
deposit1StringAmount 1 of microdeposit for account verification
deposit2StringAmount 2 of microdeposit for account verification
checkProofIdStringId of check proof image generated by Smart Payables
passportBankAccountStatusStringStatus 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


Priority Technology Holdings Logo