Skip to main content
POST
/
gateway
/
v3
/
notify
Submit a notification of payment intent
curl --request POST \
  --url https://payapi-sandbox.ingo.money/gateway/v3/notify \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participant_id": 12345,
  "amount": "250.00",
  "workflow_id": 1,
  "participant_unique_id1": "a4f1b2c3-d456-789e-f012-34567890abcd",
  "participant_unique_id2": "b5e2c3d4-e567-890f-a123-456789012345",
  "tracer_id": "trc-20260422-001",
  "recipient": {
    "customer_id": "cust-001",
    "first_name": "Alex",
    "last_name": "Rivera",
    "email": "johnny.rockets@example.com",
    "mobile": "5555550100",
    "address1": "100 Innovation Way",
    "address2": "",
    "city": "Anytown",
    "state": "GA",
    "zip": "00000",
    "phone": "5555550100"
  },
  "authentication_records": [
    {
      "field_label": "Last 4 SSN",
      "field_order": 1,
      "validation_type": 1,
      "match_failure_type": 1,
      "value_format": "XXXX",
      "client_provided_value": "1234"
    }
  ],
  "notification_records": [
    {
      "field_label": "Account",
      "client_provided_value": "Checking Account ending 5678"
    }
  ]
}
'
{
  "status": 100,
  "client_message": "Success",
  "data": {
    "notification_id": 9876543,
    "tracer_id": "trc-20260422-001",
    "participant_unique_id1": "PARTNER-REF-001",
    "participant_unique_id2": "PARTNER-REF-002",
    "request_timestamp": 1700000000
  },
  "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

authentication_records[] is required by default but may be optional based on client OTAC configuration. recipient.mobile conditionality depends on OTAC configuration.

​
participant_id
integer
required

Unique participant identifier assigned by Ingo.

Example:

12345

​
amount
string
required

Dollar amount of the disbursement. Must be greater than 0 with a maximum of 2 decimal places.

Maximum string length: 10
Example:

"250.00"

​
workflow_id
integer
required

Ingo-assigned workflow identifier that determines the disbursement flow configuration. Defaults to 1 if not otherwise specified by your Ingo integration manager.

Example:

1

​
participant_unique_id1
string
required

Participant assigned transaction ID. Must be unique. Used for idempotency — a duplicate value returns an idempotent response. Appears on daily reconciliation reports.

Required string length: 1 - 100
Example:

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

​
recipient
object
required

Information about the disbursement recipient. Provide either first_name + last_name or business_name — not both. business_name requires client-level configuration. mobile conditionality depends on OTAC configuration.

​
participant_unique_id2
string | null

Optional second participant assigned transaction ID.

Maximum string length: 100
Example:

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

​
authentication_records
object[]

Array of authentication challenge records used to verify the recipient's identity before releasing the disbursement. Required by default — may be optional based on client OTAC configuration. Maximum 20 records.

Required array length: 1 - 20 elements
​
notification_records
object[] | null

Optional array of supplemental notification records displayed in the recipient notification. Certain records may be required based on client configuration.

​
language
enum<string> | null

IETF locale code specifying the language for the notification. Conditional on alternate_language_enabled client configuration.

Available options:
ar-SA,
cs-CZ,
da-DK,
de-DE,
en-GB,
en-US,
es-ES,
es-US,
fa-IR,
fi-FI,
fr-FR,
hmn-Latn,
it-IT,
ja-JP,
km-KH,
ko-KR,
nb-NO,
nl-NL,
pl-PL,
pt-BR,
ru-RU,
sv-SE,
tl-PH,
tr-TR,
vi-VN,
zh-CN,
zh-Hans,
zh-TW
Maximum string length: 8
Example:

"en-US"

​
document_link
string | null

Optional URL to a document to be embedded in the recipient notification. Required when the client is configured for document embedding (document_embedding_enabled).

Maximum string length: 2048
Example:

"https://example.com/documents/agreement.pdf"

Response

Notification submitted 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:

"Success"

​
data
object

Response data for the staged notification.

​
time
string

Server-side request processing time in seconds.

Example:

"0.85"