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

Cancel a payment before it’s been processed

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

fsi-stop-payment:write

Path Params

contact_id

string

required

The contact id

Query Params

interaction_id

string

The interaction id

Body Params

account_id

string

required

length ≤ 22

account id

account_type

string

length ≤ 30

The account type

member_id

string

length ≤ 22

member id

branch_id

string

length ≤ 30

The branch id

check_number

string

length ≤ 22

The check number

check_number_range

object

payee_name

string

length ≤ 25

The payee name

check_currency_code_type

string

length ≤ 25

check currency code type

check_currency_code_value

string

required

length ≤ 25

check currency code value

check_amount

string

length ≤ 25

The check amount

check_amount_variance

string

length ≤ 25

check amount variance

check_amount_range

object

check_date

string

length ≤ 25

Date on which the customer wrote the check

stop_check_date

string

length ≤ 25

Date on which the stop check request is initiated

expiration_date

string

length ≤ 25

Date after which stop check is inactive

stop_type

string

enum

required

Stop payment scenario type

Allowed:

stop_check_reason

string

enum

Specifies the reason for the stop check

fees

string

length ≤ 25

Transaction fee for a stop check transaction digital string

waive_fee

boolean

waive fee for a stop check transaction

match_check_number

boolean

match check number for a stop check transaction

ach

boolean

ach for a stop check transaction

ach_debit_credit

string

enum

length ≤ 30

ach debit credit number for a stop check transaction

Allowed:

card_signed

boolean

sign card

print_receipt_code

string

length ≤ 25

print receipt code

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