Search

POST

gateway

Search for a biller or payee

curl --request POST \
  --url https://payapi-sandbox.ingo.money/gateway/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participant_id": 12345,
  "account_type": "BP",
  "account": "12345678",
  "payee_name": "Anytown Utilities",
  "payee_city": "Anytown",
  "payee_state": "GA",
  "payee_zip": "00000",
  "participant_unique_id1": "PARTNER-REF-001",
  "participant_unique_id2": "PARTNER-REF-002",
  "timestamp": 1586975609,
  "version": 11
}
'

import requests

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

payload = {
    "participant_id": 12345,
    "account_type": "BP",
    "account": "12345678",
    "payee_name": "Anytown Utilities",
    "payee_city": "Anytown",
    "payee_state": "GA",
    "payee_zip": "00000",
    "participant_unique_id1": "PARTNER-REF-001",
    "participant_unique_id2": "PARTNER-REF-002",
    "timestamp": 1586975609,
    "version": 11
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    participant_id: 12345,
    account_type: 'BP',
    account: '12345678',
    payee_name: 'Anytown Utilities',
    payee_city: 'Anytown',
    payee_state: 'GA',
    payee_zip: '00000',
    participant_unique_id1: 'PARTNER-REF-001',
    participant_unique_id2: 'PARTNER-REF-002',
    timestamp: 1586975609,
    version: 11
  })
};

fetch('https://payapi-sandbox.ingo.money/gateway/search', 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/search",
  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([
    'participant_id' => 12345,
    'account_type' => 'BP',
    'account' => '12345678',
    'payee_name' => 'Anytown Utilities',
    'payee_city' => 'Anytown',
    'payee_state' => 'GA',
    'payee_zip' => '00000',
    'participant_unique_id1' => 'PARTNER-REF-001',
    'participant_unique_id2' => 'PARTNER-REF-002',
    'timestamp' => 1586975609,
    'version' => 11
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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/search"

	payload := strings.NewReader("{\n  \"participant_id\": 12345,\n  \"account_type\": \"BP\",\n  \"account\": \"12345678\",\n  \"payee_name\": \"Anytown Utilities\",\n  \"payee_city\": \"Anytown\",\n  \"payee_state\": \"GA\",\n  \"payee_zip\": \"00000\",\n  \"participant_unique_id1\": \"PARTNER-REF-001\",\n  \"participant_unique_id2\": \"PARTNER-REF-002\",\n  \"timestamp\": 1586975609,\n  \"version\": 11\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"participant_id\": 12345,\n  \"account_type\": \"BP\",\n  \"account\": \"12345678\",\n  \"payee_name\": \"Anytown Utilities\",\n  \"payee_city\": \"Anytown\",\n  \"payee_state\": \"GA\",\n  \"payee_zip\": \"00000\",\n  \"participant_unique_id1\": \"PARTNER-REF-001\",\n  \"participant_unique_id2\": \"PARTNER-REF-002\",\n  \"timestamp\": 1586975609,\n  \"version\": 11\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"participant_id\": 12345,\n  \"account_type\": \"BP\",\n  \"account\": \"12345678\",\n  \"payee_name\": \"Anytown Utilities\",\n  \"payee_city\": \"Anytown\",\n  \"payee_state\": \"GA\",\n  \"payee_zip\": \"00000\",\n  \"participant_unique_id1\": \"PARTNER-REF-001\",\n  \"participant_unique_id2\": \"PARTNER-REF-002\",\n  \"timestamp\": 1586975609,\n  \"version\": 11\n}"

response = http.request(request)
puts response.read_body

{
  "status": 100,
  "client_message": "Success",
  "data": {
    "count": 2,
    "issuers": [
      {
        "payee_id": "123456",
        "payee_name": "Anytown Utilities",
        "payee_address": "100 Innovation Way",
        "payee_city": "Anytown",
        "payee_state": "GA",
        "payee_zip": "00000",
        "min": "5.00",
        "max": "2000.00",
        "card_type": "NA",
        "issuing_network": "NA",
        "estimated_posting_time": "Payment will post 04/17/2026",
        "estimated_posting_date": "04/17/2026",
        "account_type": "BP"
      },
      {
        "payee_id": "123457",
        "payee_name": "Anytown Utilities North",
        "payee_address": "100 Innovation Way",
        "payee_city": "Anytown",
        "payee_state": "GA",
        "payee_zip": "00000",
        "min": "5.00",
        "max": "2000.00",
        "card_type": "NA",
        "issuing_network": "NA",
        "estimated_posting_time": "Payment will post 04/17/2026",
        "estimated_posting_date": "04/17/2026",
        "account_type": "BP"
      }
    ],
    "request_timestamp": 1587050949,
    "participant_unique_id1": "PARTNER-REF-001",
    "participant_unique_id2": "PARTNER-REF-002"
  },
  "time": "1.8152"
}

Body

application/json

store_id, clerk_id, and terminal_id are required when the client is configured as a retail participant (retail flag enabled in client configuration).

participant_id

integer

required

Unique participant identifier generated by Ingo.

Example:

12345

account_type

enum<string>

required

For Bill Payment the value should be set to BP. Search is supported for the BillPay distribution only; results indicate per-issuer whether to continue with the card (CA) or BillPay (BP) Verify and Process sequence.

Available options:

BP

Required string length: 2

Example:

"BP"

account

string

required

Customer account number to search against.

Required string length: 1 - 255

Example:

"12345678"

participant_unique_id1

string

required

Participant provided unique transaction identifier. Echoed back on the response.

Required string length: 1 - 255

Example:

"PARTNER-REF-001"

timestamp

integer

required

Unix timestamp of the request.

Example:

1586975609

version

integer

required

API version of the request. Current version is: 11.

Example:

11

amount

number<float> | null

Dollar amount of the intended disbursement. When provided, used to validate against biller transaction limits.

Required range: x >= 0.01

Example:

1010.5

payee_name

string | null

Name of payee (biller/issuer).

Maximum string length: 255

Example:

"Anytown Utilities"

payee_address1

string | null

Payee (biller/issuer) remittance address 1.

Maximum string length: 255

Example:

"100 Innovation Way"

payee_address2

string | null

Payee (biller/issuer) remittance address 2.

Maximum string length: 255

Example:

"Suite 200"

payee_city

string | null

Payee (biller/issuer) remittance city.

Maximum string length: 255

Example:

"Anytown"

payee_state

string | null

Payee (biller/issuer) remittance state (standard US postal abbreviation, uppercase).

Required string length: 2

Pattern:

^(?:A[LKSZRAEP]|C[AOT]|D[EC]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOPST]|N[CDEHJMVY]|O[HKR]|P[ARW]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])$

Example:

"GA"

payee_zip

string | null

Payee (biller/issuer) remittance zip — 5 digit or 10 digit (xxxxx or xxxxx-xxxx).

Maximum string length: 10

Pattern: ^[0-9]{5}(?:-[0-9]{4})?$

Example:

"00000"

store_id

string | null

Participant assigned store ID. Required when the client is configured as a retail participant (retail flag enabled in client configuration).

Maximum string length: 255

Example:

"STORE-001"

clerk_id

string | null

Participant assigned clerk ID. Required when the client is configured as a retail participant (retail flag enabled in client configuration).

Maximum string length: 255

Example:

"CLK-007"

terminal_id

string | null

Participant assigned terminal ID. Required when the client is configured as a retail participant (retail flag enabled in client configuration).

Maximum string length: 255

Example:

"TERM-042"

participant_unique_id2

string | null

Optional second participant provided unique transaction identifier. Echoed back on the response only when supplied on the request.

Maximum string length: 255

Example:

"PARTNER-REF-002"

Response

200 - application/json

Search completed

status

integer

Numeric code describing the status of the API request (for example, 100 = Success). See the API Status Codes reference for the full list.

Example:

100

client_message

string

Text description associated with the status code.

Example:

"Success"

data

object

Information about the results of the search.

Show child attributes

time

string

Time in seconds to complete the request.

Example:

"1.8152"

Search for a biller or payee

curl --request POST \
  --url https://payapi-sandbox.ingo.money/gateway/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participant_id": 12345,
  "account_type": "BP",
  "account": "12345678",
  "payee_name": "Anytown Utilities",
  "payee_city": "Anytown",
  "payee_state": "GA",
  "payee_zip": "00000",
  "participant_unique_id1": "PARTNER-REF-001",
  "participant_unique_id2": "PARTNER-REF-002",
  "timestamp": 1586975609,
  "version": 11
}
'

import requests

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

payload = {
    "participant_id": 12345,
    "account_type": "BP",
    "account": "12345678",
    "payee_name": "Anytown Utilities",
    "payee_city": "Anytown",
    "payee_state": "GA",
    "payee_zip": "00000",
    "participant_unique_id1": "PARTNER-REF-001",
    "participant_unique_id2": "PARTNER-REF-002",
    "timestamp": 1586975609,
    "version": 11
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    participant_id: 12345,
    account_type: 'BP',
    account: '12345678',
    payee_name: 'Anytown Utilities',
    payee_city: 'Anytown',
    payee_state: 'GA',
    payee_zip: '00000',
    participant_unique_id1: 'PARTNER-REF-001',
    participant_unique_id2: 'PARTNER-REF-002',
    timestamp: 1586975609,
    version: 11
  })
};

fetch('https://payapi-sandbox.ingo.money/gateway/search', 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/search",
  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([
    'participant_id' => 12345,
    'account_type' => 'BP',
    'account' => '12345678',
    'payee_name' => 'Anytown Utilities',
    'payee_city' => 'Anytown',
    'payee_state' => 'GA',
    'payee_zip' => '00000',
    'participant_unique_id1' => 'PARTNER-REF-001',
    'participant_unique_id2' => 'PARTNER-REF-002',
    'timestamp' => 1586975609,
    'version' => 11
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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/search"

	payload := strings.NewReader("{\n  \"participant_id\": 12345,\n  \"account_type\": \"BP\",\n  \"account\": \"12345678\",\n  \"payee_name\": \"Anytown Utilities\",\n  \"payee_city\": \"Anytown\",\n  \"payee_state\": \"GA\",\n  \"payee_zip\": \"00000\",\n  \"participant_unique_id1\": \"PARTNER-REF-001\",\n  \"participant_unique_id2\": \"PARTNER-REF-002\",\n  \"timestamp\": 1586975609,\n  \"version\": 11\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"participant_id\": 12345,\n  \"account_type\": \"BP\",\n  \"account\": \"12345678\",\n  \"payee_name\": \"Anytown Utilities\",\n  \"payee_city\": \"Anytown\",\n  \"payee_state\": \"GA\",\n  \"payee_zip\": \"00000\",\n  \"participant_unique_id1\": \"PARTNER-REF-001\",\n  \"participant_unique_id2\": \"PARTNER-REF-002\",\n  \"timestamp\": 1586975609,\n  \"version\": 11\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"participant_id\": 12345,\n  \"account_type\": \"BP\",\n  \"account\": \"12345678\",\n  \"payee_name\": \"Anytown Utilities\",\n  \"payee_city\": \"Anytown\",\n  \"payee_state\": \"GA\",\n  \"payee_zip\": \"00000\",\n  \"participant_unique_id1\": \"PARTNER-REF-001\",\n  \"participant_unique_id2\": \"PARTNER-REF-002\",\n  \"timestamp\": 1586975609,\n  \"version\": 11\n}"

response = http.request(request)
puts response.read_body

{
  "status": 100,
  "client_message": "Success",
  "data": {
    "count": 2,
    "issuers": [
      {
        "payee_id": "123456",
        "payee_name": "Anytown Utilities",
        "payee_address": "100 Innovation Way",
        "payee_city": "Anytown",
        "payee_state": "GA",
        "payee_zip": "00000",
        "min": "5.00",
        "max": "2000.00",
        "card_type": "NA",
        "issuing_network": "NA",
        "estimated_posting_time": "Payment will post 04/17/2026",
        "estimated_posting_date": "04/17/2026",
        "account_type": "BP"
      },
      {
        "payee_id": "123457",
        "payee_name": "Anytown Utilities North",
        "payee_address": "100 Innovation Way",
        "payee_city": "Anytown",
        "payee_state": "GA",
        "payee_zip": "00000",
        "min": "5.00",
        "max": "2000.00",
        "card_type": "NA",
        "issuing_network": "NA",
        "estimated_posting_time": "Payment will post 04/17/2026",
        "estimated_posting_date": "04/17/2026",
        "account_type": "BP"
      }
    ],
    "request_timestamp": 1587050949,
    "participant_unique_id1": "PARTNER-REF-001",
    "participant_unique_id2": "PARTNER-REF-002"
  },
  "time": "1.8152"
}

Overview

API Reference

Webhooks

Body

Response