Checks


With your existing Checkbook.io account, you can easily send checks using one simple POST call to our check endpoints. We have two different endpoints for sending checks. One for Digital Checks and another one for paper checks that are mailed via USPS. Digital Checks are obviously more efficient i.e. delivered instantly, trackable on both sides and cost less! Furthermore, with Digital Checks you can create your own branding by white labeling the entire solution as well as select the check cashing options you want to provide to the recipient through direct deposit, printing or instant pay. In addition, you can attach all the remittance information you want to either in text or in pdf format.


POST   /v3/check/digital

Name: John Doe

Recipient: johndoe@example.com

Amount: 1.00

To create a Digital Check all you need is the name, email, and amount

GET   /v3/check/digital

Name: John Doe

Recipient: johndoe@example.com

Amount: 1.00

ID: 654321781234567812

Once a check has been created, it will be given a check ID

DELETE   /v3/check/digital

ID: 654321781234567812

Check ID’s are unique to each check, and can be used to look up or even delete the check


If you already have the recipient’s bank account info you can push the funds via Digital Check directly to the recipient’s bank account. No interaction required from the recipient. Let us know by sending an email to support@checkbook.io if you’d like this option and we’ll send you the extended API.


Invoices


With your existing Checkbook.io account you can easily request payments using one simple POST call to our invoice endpoints. We have one endpoint for invoices (invoices are only delivered via email). The recipient of the invoice clicks on the “Send Check” button to pay the Invoice using a Digital Check. It’s really that simple. In addition, you can attach billing, receipts, or other information in text or pdf format.


POST   /v3/invoice

Name: John Doe

Recipient: johndoe@example.com

Amount: 1.00

To create an invoice all you need is the Name, Email, and Amount

GET   /v3/invoice

Name: John Doe

Recipient: johndoe@example.com

Amount: 1.00

ID: 654321781234567812

Once an invoice has been created It will be given an id

DELETE   /v3/invoice

ID: 654321781234567812

ID’s are unique to each invoice, and can be used to look up or even delete the check


Subscriptions


Users are able to create both recurring invoices and checks. Creating these recurring transactions is similar to creating a normal check or invoice in that you need three key components: name, email and amount. The only difference is “interval”, which can be set to monthly or weekly. That’s it and you’ve got recurring payments going. Best of all the recipient simply has to click one checkbox to enable to collect payments from them every month automatically.


POST   /v3/subscription/check

Name: John Doe

Recipient: johndoe@example.com

Amount: 1.00

Interval: Weekly

To create an check subscription, all you need is a name, email, amount, and interval


POST   /v3/subscription/invoice

Name: John Doe

Recipient: johndoe@example.com

Amount: 1.00

Description: "Rent"

Interval: Monthly

To create an invoice subscription, all you need is a name, email, amount, description, and interval

GET   /v3/subscription

Name: John Doe

Recipient: johndoe@example.com

Amount: 1.00

ID: 654321781234567812

Interval: Weekly

All subscriptions can be grabbed on your account or a specific one using an ID

DELETE   /v3/subscription/ 1234

ID: 654321781234567812

Each subscription is given an ID and can be used to delete it.


PUT   /v3/subscription

Skipped: 1

To skip a subscription, give the number of duration periods to skip


You can use the API to make calls to delete or skip dates using the DELETE and PUT calls respectively, enabling you to skip a certain payment.


Marketplace


For developers who want complete control over the entire experience, this option may best fit your needs. For our marketplace solution, we give you the endpoints and let you control the UI/UX for all payments within your marketplace. With our OAuth API, other users can easily grant you access to send or receive checks on their behalf. Once access has been granted, the access token will be securely sent to a callback url on your server. Finally for this integration, there are a few steps listed below that will need to performed before merchants within your marketplace can send payments.


POST   /v3/user

Name: John Doe

User ID: johndoe@example.com

To get started, create a user using your primary marketplace account

/v3/invoice

POST   /v3/bank/iav

Account: 000011112222

Type: CHECKING

Institution ID: ins_120003

/v3/check

/v3/subscription



  1. You will first need to onboard your marketplace users. These users will be unique to your business, so if they already have a checkbook.io account, or they visit https://checkbook.io and sign up for an account, this will be a separate account from the marketplace account.
  2. To onboard these users, you will create a POST request to /v3/user (https://www.checkbook.io/docs/reference#user), supplying a user_id for the user, and the user’s name. The response from this api call will include the new user’s api key and api secret. For additional further requests to onboard/send money on behalf of this user, you will use their api keys.
  3. Next, you will need to add a bank for the new user (https://www.checkbook.io/docs/api/reference#bank). If you know the user’s routing and account number, you can add their account with a POST request to /v3/bank. This will create a pending bank account. This means that we will generate microdeposit transactions to the user’s account to verify ownership. These typically show up the next business day, but may show up the same business day. The bank account can then be verified by POSTing the microdeposit amounts to /v3/bank/verify.
  4. Once a verified bank account has been added for the marketplace user, payments can be sent between users of the marketplace by inserting the user_id in the <recipient> field of the /v3/check/digital POST request.

Integrations


Checkbook.io also offers solutions to integrate our solution into your existing application via:

With QuickBooks

With Accounting Seed

With osCommerce

With WordPress