post https://api.talkdeskapp.com/fsi/checks//search
Search status of a check by providing the unique account ID and check number as parameters.
Scope
fsi-checks:read
Body Response - Schema
200 (ok)
Parameter | Type | Description | Required |
---|---|---|---|
id | string | The primary id. <= 30 characters | no |
heck_status | string | The 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)
Parameter | Type | Description | Required |
---|---|---|---|
code | string | n/a | yes |
message | string | n/a | yes |
description | string | n/a | no |
fields | array[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.