Search Check Status

Search status of a check by providing the unique account ID and check number as parameters.

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

fsi-checks:read

Body Response - Schema

200 (ok)


ParameterTypeDescriptionRequired
idstringThe primary id. <= 30 charactersno
heck_statusstringThe check status. <= 30 characters
Allowed values:
CLEARED
PENDING
VOIDED
STALE_DATED
STOP_PAYMENT
RETURNED
IN_PROCESS
REVERSED
OTHER
UNKNOWN
yes

400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

❗️

API Availability

The FSI Integrations API has been in General Availability since January 2023.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!