Enable users to cancel various types of payments, including personal checks, before they are processed.

post

https://api.talkdeskapp.com/fsi/stop/{contact_id}/payments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

fsi-stop-payment:write

Path Params

contact_id

string

required

Query Params

interaction_id

string

Body Params

account_id

string

required

length ≤ 22

account_type

string

length ≤ 30

member_id

string

length ≤ 22

branch_id

string

length ≤ 30

check_number

string

length ≤ 22

check_number_range

object

payee_name

string

length ≤ 25

check_currency_code_type

string

length ≤ 25

check_currency_code_value

string

required

length ≤ 25

check_amount

string

length ≤ 25

check_amount_variance

string

length ≤ 25

check_amount_range

object

check_date

string

length ≤ 25

stop_check_date

string

length ≤ 25

expiration_date

string

length ≤ 25

stop_type

string

enum

required

Allowed:

stop_check_reason

string

enum

fees

string

length ≤ 25

waive_fee

boolean

match_check_number

boolean

ach

boolean

ach_debit_credit

string

enum

length ≤ 30

Allowed:

card_signed

boolean

print_receipt_code

string

length ≤ 25

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200The stop payment response.

400Bad Request

401Unauthorized

403Forbidden

404Not Found