Skip to main content
POST
/
gateway
/
v3
/
notifycancel
Cancel a staged disbursement
curl --request POST \
  --url https://payapi-sandbox.ingo.money/gateway/v3/notifycancel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participant_id": 12345,
  "participant_unique_id1": "a4f1b2c3-d456-789e-f012-34567890abcd",
  "first_name": "Alex",
  "last_name": "Rivera",
  "amount": "250.00",
  "tracer_id": "trc-20260422-001",
  "notification_id": 9876543,
  "customer_id": "cust-001",
  "participant_unique_id2": "b5e2c3d4-e567-890f-a123-456789012345"
}
'
{
  "status": 100,
  "client_message": "Disbursement Request Canceled",
  "data": {
    "notification_id": "9876543",
    "participant_unique_id1": "PARTNER-REF-001",
    "tracer_id": "trc-20260422-001",
    "request_timestamp": 1700000000,
    "participant_unique_id2": "PARTNER-REF-002"
  },
  "time": "0.85"
}

Authorizations

​
Authorization
string
header
required

HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.

Body

application/json

Cancels a staged disbursement. The transaction is located using participant_unique_id1 and tracer_id. Compatible with disbursements staged via Notify v3 or Notify v4.

​
participant_id
integer
required

Unique participant identifier assigned by Ingo.

Example:

12345

​
participant_unique_id1
string
required

Participant assigned transaction ID provided on the original Notify request.

Required string length: 1 - 254
Example:

"a4f1b2c3-d456-789e-f012-34567890abcd"

​
first_name
string
required

Recipient first name as provided on the original Notify request.

Required string length: 1 - 150
Example:

"Johnny"

​
last_name
string
required

Recipient last name as provided on the original Notify request.

Required string length: 1 - 150
Example:

"Rockets"

​
amount
string
required

Dollar amount of the disbursement as provided on the original Notify request.

Example:

"250.00"

​
tracer_id
string
required

Tracer ID associated with the original Notify request.

Maximum string length: 254
Example:

"trc-20260422-001"

​
notification_id
integer | null

Optional Ingo assigned notification ID returned on the original Notify response. When provided, used as an additional identifier to locate the staged disbursement.

Example:

9876543

​
customer_id
string | null

Optional client assigned customer identifier.

Maximum string length: 254
Example:

"cust-001"

​
participant_unique_id2
string | null

Optional second participant assigned transaction ID as provided on the original Notify request.

Maximum string length: 254
Example:

"b5e2c3d4-e567-890f-a123-456789012345"

Response

Disbursement cancelled successfully

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

"Disbursement Request Canceled"

​
data
object