Get Started
Bank Account
Check
Create Checks
Allows the creation of one or more checks in a single request. Advanced stubs can be included by passing a voucher object.
curl --request POST \
--url https://test.onlinecheckwriter.com/api/v3/checks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"checks": [
{
"bankAccountId": "6gYVewBOP7Gdx7b",
"payeeId": "ijKVewBOP7GdyhG",
"categoryId": "",
"serialNumber": "1001",
"issueDate": "2020-10-25",
"amount": 100,
"memo": "First, Test check using API",
"note": "",
"accountNumber": "458756",
"invoiceNumber": "2545",
"noSign": false,
"noAmount": false,
"noDate": false,
"noPayee": false,
"voucherId": null,
"customElements": {
"element1": "first class tracking",
"element2": "test sender"
}
}
]
}'{
"success": true,
"message": "Successfully created",
"data": {
"checks": [
{
"checkId": "<string>",
"serialNumber": "<string>",
"amount": "<string>",
"status": 123,
"bankAccount": {
"bankAccountId": "<string>",
"name": "<string>"
},
"payee": {
"payeeId": "<string>",
"name": "<string>"
}
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Must be a valid bank account ID.
Must be a valid payee ID. Optional if noPayee is true.
Category ID, if applicable.
Custom serial number for the check.
Issue date of the check.
Amount of the check. Required unless noAmount is true.
Memo for the check.
Internal note for the check.
Account number associated with the check.
Invoice number associated with the check.
If true, creates the check without a signature. Defaults to false.
If true, creates the check without an amount. Defaults to false.
If true, creates the check without a date. Defaults to false.
If true, creates the check without a payee. Defaults to false.
Voucher ID, if applicable. Ignored if voucher is passed.
Voucher number.
Memo associated with the voucher.
Voucher date.
Invoice number associated with the voucher item.
Name of the voucher item.
Description of the voucher item.
Quantity of the voucher item.
Unit cost of the voucher item.
Total amount for the voucher item.
Response
true
"Successfully created"
curl --request POST \
--url https://test.onlinecheckwriter.com/api/v3/checks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"checks": [
{
"bankAccountId": "6gYVewBOP7Gdx7b",
"payeeId": "ijKVewBOP7GdyhG",
"categoryId": "",
"serialNumber": "1001",
"issueDate": "2020-10-25",
"amount": 100,
"memo": "First, Test check using API",
"note": "",
"accountNumber": "458756",
"invoiceNumber": "2545",
"noSign": false,
"noAmount": false,
"noDate": false,
"noPayee": false,
"voucherId": null,
"customElements": {
"element1": "first class tracking",
"element2": "test sender"
}
}
]
}'{
"success": true,
"message": "Successfully created",
"data": {
"checks": [
{
"checkId": "<string>",
"serialNumber": "<string>",
"amount": "<string>",
"status": 123,
"bankAccount": {
"bankAccountId": "<string>",
"name": "<string>"
},
"payee": {
"payeeId": "<string>",
"name": "<string>"
}
}
]
}
}