Skip to main content
POST
/
checks
Create Checks
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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload to create one or more checks.

​
checks
object[]

Response

Check(s) created successfully.

​
success
boolean
Example:

true

​
message
string
Example:

"Successfully created"

​
data
object