Skip to main content
POST
Search for a biller by account number

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 assigned by Ingo.

Example:

12345

account
string
required

Customer bill payment account number to search against.

Maximum string length: 255
Example:

"12345678"

amount
number<float> | null

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

Required range: x >= 0.01
Example:

1010.5

rail_type
enum<string> | null

Optional rail type filter. CREDIT = push (credit) disbursement, DEBIT = pull (debit) transaction. Defaults to CREDIT when not provided.

Available options:
CREDIT,
DEBIT
Maximum string length: 6
Example:

"CREDIT"

store_id
string | null

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

Maximum string length: 255
Example:

"STORE-001"

clerk_id
string | null

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

Maximum string length: 255
Example:

"CLK-007"

terminal_id
string | null

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

Maximum string length: 255
Example:

"TERM-042"

Response

Biller search successful

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