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"
        }
      ]
    }
  ]
}
'
import requests

url = "https://payapi-sandbox.ingo.money/gateway/v4/notify"

payload = {
"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"
}
]
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}
]
}
]
})
};

fetch('https://payapi-sandbox.ingo.money/gateway/v4/notify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://payapi-sandbox.ingo.money/gateway/v4/notify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://payapi-sandbox.ingo.money/gateway/v4/notify"

payload := strings.NewReader("{\n \"request\": {\n \"participant_id\": 12345,\n \"timestamp\": 1745356800\n },\n \"transaction\": {\n \"transaction_amount\": {\n \"amount\": 250,\n \"currency_code\": \"USD\"\n },\n \"participant_unique_ids\": {\n \"participant_unique_id1\": \"a4f1b2c3-d456-789e-f012-34567890abcd\",\n \"participant_unique_id2\": \"b5e2c3d4-e567-890f-a123-456789012345\"\n },\n \"workflow_id\": 1,\n \"notify_type\": 0,\n \"sender\": {\n \"name_personal\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rivera\"\n },\n \"contact_address\": {\n \"address1\": \"100 Innovation Way\",\n \"city\": \"Anytown\",\n \"state\": \"GA\",\n \"zip\": \"00000\"\n },\n \"contact_telcom\": {\n \"email\": \"noreply@example.com\"\n },\n \"sender_account\": \"sender-acct-001\"\n }\n },\n \"transaction_parties\": [\n {\n \"settings\": {\n \"client_provided_id\": \"party-001\",\n \"role\": 0,\n \"classification\": 1,\n \"recipient_enabled\": 1\n },\n \"name_personal\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rivera\"\n },\n \"contact_telcom\": {\n \"email\": \"johnny.rockets@example.com\",\n \"phone_mobile\": \"5555550100\"\n },\n \"contact_address\": {\n \"address1\": \"100 Innovation Way\",\n \"address2\": \"\",\n \"city\": \"Anytown\",\n \"state\": \"GA\",\n \"zip\": \"00000\"\n },\n \"authentication\": [\n {\n \"field_label\": \"Last 4 SSN\",\n \"field_order\": 1,\n \"validation_type\": 1,\n \"match_failure_type\": 1,\n \"value_format\": \"XXXX\",\n \"client_provided_value\": \"1234\"\n }\n ],\n \"notification\": [\n {\n \"field_label\": \"Account\",\n \"client_provided_value\": \"Checking Account ending 5678\"\n }\n ]\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://payapi-sandbox.ingo.money/gateway/v4/notify")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"request\": {\n \"participant_id\": 12345,\n \"timestamp\": 1745356800\n },\n \"transaction\": {\n \"transaction_amount\": {\n \"amount\": 250,\n \"currency_code\": \"USD\"\n },\n \"participant_unique_ids\": {\n \"participant_unique_id1\": \"a4f1b2c3-d456-789e-f012-34567890abcd\",\n \"participant_unique_id2\": \"b5e2c3d4-e567-890f-a123-456789012345\"\n },\n \"workflow_id\": 1,\n \"notify_type\": 0,\n \"sender\": {\n \"name_personal\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rivera\"\n },\n \"contact_address\": {\n \"address1\": \"100 Innovation Way\",\n \"city\": \"Anytown\",\n \"state\": \"GA\",\n \"zip\": \"00000\"\n },\n \"contact_telcom\": {\n \"email\": \"noreply@example.com\"\n },\n \"sender_account\": \"sender-acct-001\"\n }\n },\n \"transaction_parties\": [\n {\n \"settings\": {\n \"client_provided_id\": \"party-001\",\n \"role\": 0,\n \"classification\": 1,\n \"recipient_enabled\": 1\n },\n \"name_personal\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rivera\"\n },\n \"contact_telcom\": {\n \"email\": \"johnny.rockets@example.com\",\n \"phone_mobile\": \"5555550100\"\n },\n \"contact_address\": {\n \"address1\": \"100 Innovation Way\",\n \"address2\": \"\",\n \"city\": \"Anytown\",\n \"state\": \"GA\",\n \"zip\": \"00000\"\n },\n \"authentication\": [\n {\n \"field_label\": \"Last 4 SSN\",\n \"field_order\": 1,\n \"validation_type\": 1,\n \"match_failure_type\": 1,\n \"value_format\": \"XXXX\",\n \"client_provided_value\": \"1234\"\n }\n ],\n \"notification\": [\n {\n \"field_label\": \"Account\",\n \"client_provided_value\": \"Checking Account ending 5678\"\n }\n ]\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://payapi-sandbox.ingo.money/gateway/v4/notify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request\": {\n \"participant_id\": 12345,\n \"timestamp\": 1745356800\n },\n \"transaction\": {\n \"transaction_amount\": {\n \"amount\": 250,\n \"currency_code\": \"USD\"\n },\n \"participant_unique_ids\": {\n \"participant_unique_id1\": \"a4f1b2c3-d456-789e-f012-34567890abcd\",\n \"participant_unique_id2\": \"b5e2c3d4-e567-890f-a123-456789012345\"\n },\n \"workflow_id\": 1,\n \"notify_type\": 0,\n \"sender\": {\n \"name_personal\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rivera\"\n },\n \"contact_address\": {\n \"address1\": \"100 Innovation Way\",\n \"city\": \"Anytown\",\n \"state\": \"GA\",\n \"zip\": \"00000\"\n },\n \"contact_telcom\": {\n \"email\": \"noreply@example.com\"\n },\n \"sender_account\": \"sender-acct-001\"\n }\n },\n \"transaction_parties\": [\n {\n \"settings\": {\n \"client_provided_id\": \"party-001\",\n \"role\": 0,\n \"classification\": 1,\n \"recipient_enabled\": 1\n },\n \"name_personal\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rivera\"\n },\n \"contact_telcom\": {\n \"email\": \"johnny.rockets@example.com\",\n \"phone_mobile\": \"5555550100\"\n },\n \"contact_address\": {\n \"address1\": \"100 Innovation Way\",\n \"address2\": \"\",\n \"city\": \"Anytown\",\n \"state\": \"GA\",\n \"zip\": \"00000\"\n },\n \"authentication\": [\n {\n \"field_label\": \"Last 4 SSN\",\n \"field_order\": 1,\n \"validation_type\": 1,\n \"match_failure_type\": 1,\n \"value_format\": \"XXXX\",\n \"client_provided_value\": \"1234\"\n }\n ],\n \"notification\": [\n {\n \"field_label\": \"Account\",\n \"client_provided_value\": \"Checking Account ending 5678\"\n }\n ]\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "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"
      }
    ]
  }
}
{
"request": {
"participant_id": 12345,
"timestamp": 1745356800
},
"response": {
"status": "400",
"message": "Validation Error"
}
}

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.