Skip to main content
POST
/
gateway
/
v4
/
notify
Submit a notification of payment intent (v4)
curl --request POST \
  --url https://payapi-sandbox.ingo.money/gateway/v4/notify \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "request": {
    "participant_id": 12345,
    "timestamp": 1745356800
  },
  "transaction": {
    "transaction_amount": {
      "amount": 250,
      "currency_code": "USD"
    },
    "participant_unique_ids": {
      "participant_unique_id1": "a4f1b2c3-d456-789e-f012-34567890abcd",
      "participant_unique_id2": "b5e2c3d4-e567-890f-a123-456789012345"
    },
    "workflow_id": 1,
    "notify_type": 0,
    "sender": {
      "name_personal": {
        "first_name": "Alex",
        "last_name": "Rivera"
      },
      "contact_address": {
        "address1": "100 Innovation Way",
        "city": "Anytown",
        "state": "GA",
        "zip": "00000"
      },
      "contact_telcom": {
        "email": "noreply@example.com"
      },
      "sender_account": "sender-acct-001"
    }
  },
  "transaction_parties": [
    {
      "settings": {
        "client_provided_id": "party-001",
        "role": 0,
        "classification": 1,
        "recipient_enabled": 1
      },
      "name_personal": {
        "first_name": "Alex",
        "last_name": "Rivera"
      },
      "contact_telcom": {
        "email": "johnny.rockets@example.com",
        "phone_mobile": "5555550100"
      },
      "contact_address": {
        "address1": "100 Innovation Way",
        "address2": "",
        "city": "Anytown",
        "state": "GA",
        "zip": "00000"
      },
      "authentication": [
        {
          "field_label": "Last 4 SSN",
          "field_order": 1,
          "validation_type": 1,
          "match_failure_type": 1,
          "value_format": "XXXX",
          "client_provided_value": "1234"
        }
      ],
      "notification": [
        {
          "field_label": "Account",
          "client_provided_value": "Checking Account ending 5678"
        }
      ]
    }
  ]
}
'
{
  "request": {
    "participant_id": 12345,
    "timestamp": 1745356800
  },
  "response": {
    "status": "100",
    "message": "Success",
    "duration": "0"
  },
  "transaction": {
    "participant_unique_ids": {
      "participant_unique_id1": "a4f1b2c3-d456-789e-f012-34567890abcd",
      "participant_unique_id2": "b5e2c3d4-e567-890f-a123-456789012345"
    },
    "notification_id": "9876543",
    "tracer_id": "trc-20260422-001",
    "parties": [
      {
        "client_provided_id": "party-001",
        "party_id": "1"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
request
object
required

General information associated with the API request.

​
transaction
object
required

Transaction-level information for the disbursement notification.

​
transaction_parties
object[]
required

Array of transaction parties. Each party defines a recipient, approver, or interested party for the disbursement notification. At least one party with role: 0 (recipient) and recipient_enabled: 1 is required.

Minimum array length: 1

Response

Notification submitted successfully

​
request
object

Echo of the request envelope.

​
response
object
​
transaction
object

Transaction outcome data.