Skip to main content
POST
/
gateway
/
checkstop
Stop payment on an issued check
curl --request POST \
  --url https://payapi-sandbox.ingo.money/gateway/checkstop \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participant_id": "12345",
  "check_number": "49379283",
  "amount": 100.04,
  "reason_code": 77,
  "explanation": "Duplicate deposit",
  "participant_unique_id1": "fc12512a-e934-447c-9316-7d2d4a86230a"
}
'
{
  "status_code": 100,
  "client_message": "Success",
  "data": {
    "check_number": "49379283",
    "transaction_id": 2361542,
    "request_timestamp": 1633470601,
    "participant_unique_id1": "fc12512a-e934-447c-9316-7d2d4a86230a"
  },
  "time": "0.8821"
}

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).

Maximum string length: 10
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 associated with the check stop request. 77 = Client Request. 78 = Internal Request.

Available options:
77,
78
Example:

77

​
explanation
string
required

Brief explanation for the check stop request.

Required string length: 1 - 80
Example:

"Duplicate deposit"

​
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:

"fc12512a-e934-447c-9316-7d2d4a86230a"

​
ledger
object

Required for clients configured for ledger service. Exclude entirely if not applicable to your integration.

Response

Check stop request submitted 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.8821"