Checkbook API Docs

Welcome to Checkbook's API! Just like our product, our API is simple to use and understand.

You'll find comprehensive guides and documentation to help you start working with Checkbook as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    API Reference

Manual Verification

Adding a bank account manually is a 3 step process:

  1. Create the bank account
  2. Release the micro-deposits
  3. Verify the bank account

Create the bank account

The API reference for creating a bank account can be found here. The interactive form allows you to test the API endpoint in our demo environment right from the reference page.

Here's an example of a request:

curl --request POST \
  --url https://demo.checkbook.io/v3/bank \
  --header 'accept: application/json' \
  --header 'authorization: 6aa2703655f4ba2af2a56202961ca86:dXbCgzYBMibj8ZwuQMd2NXr6rtvjZ8' \
  --header 'content-type: application/json' \
  --data '{"routing":"021000021","account":"12340000","type":"CHECKING"}'

And the corresponding response:

{
    "account": "0000",
    "billing": false,
    "date": "2019-06-11 00:40:58",
    "default": false,
    "id": "0cdcab79b61642a48c9ad8c83909dc17",
    "name": null,
    "routing": "021000021",
    "status": "DEPOSIT_ONLY",
    "type": "CHECKING"
}

The bank account is created with the DEPOSIT_ONLYstatus. That means it can be used to receive payments, no further action required. However, if you want to be able to send checks from that account, then you need to verify it by first releasing the micro-deposits.

๐Ÿ“˜

Note

The previous request is for the demo environment. You will need to use either the sandbox endpoint if you want to send test checks, or the production endpoint if you want to send real checks.

Release the micro-deposits

This consists of making two micro-deposits on the newly added bank account, which will show up the next working day. Once the micro-deposits have arrived in the bank account, you need to verify the bank account.

๐Ÿ‘

Micro-deposits for Real-time Payments

Checkbookโ€™s real-time payment solution utilizes the RTP network provided by The Clearing House. The micro-deposits will be credited in real-time into the bank account in less than 60 seconds.

The API reference for releasing the micro-deposits can be found here. The interactive form allows you to test the API endpoint in our demo environment right from the reference page.

Here's an example of a request:

curl --request POST \
  --url https://demo.checkbook.io/v3/bank/release \
  --header 'content-type: application/json' \
  --data '{"account":"0cdcab79b61642a48c9ad8c83909dc17"}'

If the request was successful, a response containing an empty JSON object ({}) will be returned and the bank account will have the PENDING status.

๐Ÿ“˜

Note

The previous request is for the demo environment. You will need to use either the sandbox endpoint if you want to send test checks, or the production endpoint if you want to send real checks.

Verify the bank account

The API reference for verifying the bank account can be found here. The interactive form allows you to test the API endpoint in our demo environment right from the reference page.

Here's an example of a request:

curl --request POST \
  --url https://demo.checkbook.io/v3/bank/verify \
  --header 'authorization: d6aa2703655f4ba2af2a56202961ca86:dXbCgzYBMibj8ZwuQMd2NXr6rtvjZ8' \
  --header 'content-type: application/json' \
  --data '{"amount_1":0.15,"amount_2":0.07}'

๐Ÿšง

Sandbox testing

On the Sandbox environment, the micro-deposits values are always 0.07 and 0.15

If the request was successful, a response containing an empty JSON object ({}) will be returned and the bank account will have the VERIFIED status.

๐Ÿ“˜

Note

The previous request is for the demo environment. You will need to use either the sandbox endpoint if you want to send test checks, or the production endpoint if you want to send real checks.

Updated 22 days ago


Manual Verification


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.