Skip to main content
POST
Cancel (void) a check disbursement

Body

application/json
participant_id
string
required

Unique participant identifier assigned by Ingo.

Maximum string length: 5
Example:

"12345"

check_number
string
required

Check number assigned to the check disbursement transaction. Provided in the Process call response (check_number field).

Example:

"49379283"

amount
number<float>
required

Amount of the transaction. Must exactly match the original transaction amount.

Required range: x >= 0.01
Example:

100.04

reason_code
enum<integer>
required

Reason code for the check cancel request. Must match the check's current transaction status. 73 = Check Not Printed (routed transactions only). 74 = Undelivered Check (issued transactions only). 75 = Client Request (issued transactions only). 76 = Internal Request (issued transactions only).

Available options:
73,
74,
75,
76
Example:

73

explanation
string
required

Brief explanation for the check cancel request.

Required string length: 1 - 150
Example:

"Check Not Printed"

participant_unique_id1
string
required

Participant assigned unique ID for the original check Process request. Must exactly match the original value.

Required string length: 1 - 255
Example:

"2ac29937-1c52-4647-ba54-f1442ffae4d1"

Response

Check cancelled successfully

status_code
integer

Numeric code describing the status of the API request. 100 = Success.

Example:

100

client_message
string

Text description associated with the status code.

Example:

"Success"

data
object

Information about identifiers associated with the transaction.

time
string

Time in seconds to complete the request.

Example:

"0.7614"