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": "a4f1b2c3-d456-789e-f012-34567890abcd",
    "tracer_id": "trc-20260422-001",
    "request_timestamp": 1745356800
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.ingopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

All requests must be authenticated using an HMAC-signed Authorization header. Ingo Money requires HMAC-SHA512 for all new integrations. SHA-512 provides a significantly larger internal state and output length than SHA-256, making it substantially more resistant to length-extension attacks and brute-force preimage attempts — properties that matter for financial API traffic where each request authorizes a real money movement.

Legacy integrations using HMAC-SHA256 remain supported but are encouraged to upgrade. SHA-256 continues to meet the current minimum security bar; however, upgrading to SHA-512 eliminates an entire class of potential vulnerabilities before they become exploitable, and aligns with NIST guidance recommending SHA-2 family algorithms with 256-bit security strength or greater for long-term use. Contact your Ingo integration manager to coordinate an algorithm upgrade.

MD5 and SHA-1 are not accepted under any circumstances. Requests signed with either algorithm will be rejected.

Authorization header format:

Authorization: hmac username="YOUR_HMAC_USERNAME", algorithm="hmac-sha512", headers="request-line x-date content-type content-length content-sha512", signature="BASE64_SIGNATURE"

Credentials provisioned by your Ingo integration manager:

  • HMAC username — identifies your integration in the Authorization header username field. Distinct from your participant identifier.

  • HMAC secret — provisioned by your Ingo integration manager. The private key used to compute the signature. Never transmit this value — store it in a secrets manager or environment variable, never in source code.

  • Participant identifier — a separate value used to identify your account within the API request payload. The name and placement differs by product family. Both the HMAC username and participant identifier are provisioned at onboarding — do not substitute one for the other.

  • API key — required for select product families as an additional per-request credential. See product-specific documentation for applicability.

See the Ingo API Authentication Guide for the complete string-to-sign construction, body hashing requirements, and timestamp validation rules.

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