This is a staging build of the docs
We've reorganized our products to make building with Codat easier than ever
Skip to main content

Payment method mapping

Enable SMBs to choose how to make payments

Users may have multiple bank accounts from which they might pay for a bill.

To enable users to select which bank account a payment should originate from, you can retrieve a list of these from the accounting platform you also have the option to create a new one should the account not exist in their platform.

In some cases your platform may support multiple payment methods and each method can be mapped to an account. You should store the mapping of the relevant accountId as this will be needed when creating the billPayment.

Foreign exchange payments 💱

If you are facilitating payments in a foreign currency, then the payment should either be converted to the currency of the account, or you can create a new account with the import currency.

The create account model provides a list of the companies enabled currencies, this will return:

  • A single value: base currency, where only the base currency is supported (e.g. USD for a company based in the United States)
  • Multiple values: reflecting values selected/enabled by a user within the package
  • No values (empty array): where all/any currencies can be selected

Retrieve a list of existing bank accounts​

If the company is making payments from a pre-existing account, then you can retrieve a list of accounts and enable them to map payment methods against each one. For example, you might offer the ability to make payments from a credit card, in which case the companies billPayments should be reconciled to a credit account.

List bank accounts
GET https://api.codat.io/companies/{companyId}/connections/{connectionId}/data/bankAccounts

Create a new account​

If the company is making payments from a payment method or account that you provide, then you should create a new account to represent this in their accounting software. This will make the companies payment reconciliation workflows in their accounting software easier.

Pre-pay account​

Typically if the payment method is one of the following:

  • Automated clearing house (ACH) or Real Time Payments (RTP)
  • Cheque / Check
  • Electronic bank transfer
  • BACS (Bankers' Automated Clearing System)

Then you should create a bank account with an accountType of Debit to represent the account the payments are being made from:

Create Bank Account
POST https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/bankAccounts

Credit account​

If you are providing a credit facility for the payment e.g.

  • Commercial Credit Card
  • BNPL (Buy now pay later)

Then you should create a bank account with an accountType of Credit to represent the account the payments are being made from:

Create Credit Account
POST https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/bankAccounts
  • Payments - Reconcile payments to the SMB's accounting software
Was this page useful?
❤️
👍
🤔
👎
😭

Contents

Suggest edits