Multi Party Payments
Verified Bank Account Needed
In order to be able to send checks, you need to have a verified bank account in our system. Please refer to the Add a Bank Account section for instructions about adding a bank account to your Checkbook.io profile.
Send Payments
Multi Party Payments
Overview
This novel feature allows you to send a multi party check to up to 5 recipients. All recipients other than the depositor must endorse the check in order for it to be deposited. You can find more details about the endorsing process here.
Recipients instantly receive their check via email and can choose to either deposit the check online or print for in person or mobile deposit. You can find more details about the deposit options here.
The API reference for sending a Multi Party Check can be found here. The interactive form allows you to test the API endpoint in our demo environment right from the reference page.
Request
curl --request POST \
--url https://demo.checkbook.io/v3/check/multi \
--header 'accept: application/json' \
--header 'authorization: d6aa2703655f4ba2af2a56202961ca86:dXbCgzYBMibj8ZwuQMd2NXr6rtvjZ8' \
--header 'content-type: application/json' \
--data '{"recipients":[{"name":"User 1","recipient":"[email protected]"},{"name":"User 2","recipient":"[email protected]"}]}'
Response
{
"amount":5,
"date":"2019-06-10 17:40:32",
"description":NULL,
"id":"db1b1cfc0739412db0efdc6dfb4e1315",
"image_uri":"https://checkbook-checks-dev.s3.amazonaws.com/b5feb4fa-2f92-454e-b244-18da596e2f90.png",
"name":"User 1 and User 2",
"number":8242,
"recipient":[
"[email protected]"
"[email protected]"
],
"status":"UNPAID"
}
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.
POST/v3/check/multi
Updated 4 months ago