post https://api.talkdeskapp.com/fsi/stop//payments
Canceling a payment before it has been processed.
Scope
fsi-stop-payment:write
Body Response - Schema
200 (stop payment response)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | The primary ID. <= 30 characters | no |
| member_id | string | The member ID. <= 30 characters | yes |
| account_id | string | The account ID. <= 22 characters | yes |
| stop_check_status_code | string | The status code for the stop check record. <= 30 characters | no |
| stop_check_status_desc | string | Brief information about the stop check status description. <= 50 characters | no |
| effective_date | string | Effective date and time when the stop check status is changed. <= 30 characters | no |
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.