Skip to navigation

Get the next check number

View as MarkdownOpen in Claude

Returns a suggested check number for the next check payout from a paypoint’s funding account. Payabli suggests the highest check number on the account’s check payouts plus one, or 1 if the account has no check history. Canceled check payouts don’t count toward the highest number.

Use the suggested value with the checkNumber field when you reissue a check, or when you create a new check payout.

Errors return HTTP 400: 3005 when the paypoint ID is invalid or inactive, and 3758 when the account ID isn’t valid for the paypoint.

Authentication

AuthorizationBearer

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

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

paypointIdlongRequired
The ID of the paypoint that owns the funding account.
accountIdstringRequired

The accountId of the bank account linked to the paypoint’s check service, such as 123-456. Find it in the paypoint’s bank account details (BankData).

Response

Success
checkNumberstring

The suggested next check number for the paypoint and funding account. Payabli returns the highest check number on the account’s check payouts plus one, or 1 if the account has no check history. Canceled check payouts don’t count.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error