Search the Ingo Payments Biller/Payee database for support of a given customer account to be funded.
The Search method allows a partner to search the entire Ingo biller database using a combination of search parameters. An array with multiple possible matches is possible. Each result will indicate if the payee/biller is card based (CA) or not (BP). Selection of a card-based (account type=CA) biller/payee would then follow the call sequence defined for the Card version of the Verify method to tokenize, and then utilize the Process method to fund the account. Alternatively, a non-card-based payee (account type=BP) would follow the noncard-based variant of the Verify method to tokenize and utilize the Process method to fund the account.
https://payapi-sandbox.ingo.money/gateway/search
Participants may declare the Content Types below in the request header to ‘Accept’ back as their response format (default is JSON):
HTTP: POST
Content Type: application/json
| PARAMETER | RQMT | TYPE | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|
| participant_id | RQD | INT | 5 | Unique participant identifier generated by Ingo |
| account_type | RQD | STR | 2 | For Bill Payment value should be set to “BP” |
| account | RQD | STR | 255 | Account number |
| amount | OPT | DEC | 40 | Dollar amount of disbursement |
| payee_name | OPT | STR | 255 | Name of payee (biller/issuer) |
| payee_address1 | OPT | STR | 255 | Payee (biller/issuer) remittance address 1 |
| payee_address2 | OPT | STR | 255 | Payee (biller/issuer) remittance address 2 |
| payee_city | OPT | STR | 255 | Payee (biller/issuer) remittance city |
| payee_state | OPT | STR | 2 | Payee (biller/issuer) remittance state. (standard postal abbreviation) |
| payee_zip | OPT | STR | 10 | Payee (biller/issuer) remittance zip – 5 digit or 10 digit (xxxxx or xxxxx-xxxx) |
| store_id | COND | STR | 255 | Participant assigned store ID. This field is required if participant is a Retail client. |
| clerk_id | COND | STR | 255 | Participant assigned clerk ID. This field is required if participant is a Retail client. |
| terminal_id | COND | STR | 255 | Participant assigned terminal ID. This field is required if participant is a Retail client. |
| participant_unique_id1 | RQD | STR | 255 | Participant provided unique transaction identifier |
| participant_unique_id2 | OPT | STR | 255 | Optional second participant provided unique transaction identifier |
| timestamp | RQD | INT | -> | Unix timestamp. |
| version | RQD | INT | 2 | Current version is: 11 |
{
"participant_id": 12345,
"account_type": "BP",
"account": "12345678",
"payee_name": "FirstService",
"payee_address1": "",
"payee_address2": "",
"payee_city": "",
"timestamp": 1586975609,
"participant_unique_id1": "f8f68709-8e5d-4c19-8ca0-2eaffef4ec57",
"participant_unique_id2": "257b5bae-d52f-42e2-8f2c-0700d8d7a7a5",
"version": "11"
}
| PARAMETER | REQ’T | TYPE | DESCRIPTION |
|---|---|---|---|
| status | RQD | INT | Numeric code describing status of API request (e.g. 100 = Success); see API Status Codes Table in the Reference section for more information |
| client_message | RQD | STR | Text description associated with status code |
| data | RQD | OBJ | Information about the results of the search |
| count | RQD | INT | Count of account issuers returned |
| issuers | RQD | OBJ | Array of issuers / payees returned matching request criteria if call is successful |
| payee_id | RQD | STR | Unique Ingo assigned identifier for the payee. This information is required on the subsequent Verify and Process method calls for the Bill Payment “BP” account_type payees |
| payee_name | RQD | STR | Name of payee (biller/issuer) |
| payee_address | RQD | STR | Payee (biller/issuer) remittance address, if available. May be blank/empty. |
| payee_city | RQD | STR | Payee (biller/issuer) remittance city, if available. May be blank/empty. |
| payee_state | RQD | STR | Payee (biller/issuer) remittance state, if available. May be blank/empty. |
| payee_zip | RQD | STR | Payee (biller/issuer) remittance zip, if available. May be blank/empty. |
| min | RQD | STR | Minimum payment amount accepted |
| max | RQD | STR | Maximum payment amount accepted |
| card_type | RQD | STR | “Debit”, “Prepaid Debit”, “Credit”, “NA” |
| issuing_network | RQD | STR | If a card, the network of issuance – “Visa”, MasterCard”, American Express”, etc. Can also be “NA” |
| estimated_posting_time | RQD | STR | Estimated posting time of the payment. Examples: “Your payment will post within 5 minutes.” or “Your payment will post todays date.” or “Your payment will post next business day’s date.” |
| estimated_posting_date | RQD | STR | Estimated posting time of the payment in date format MM/DD/YYYY |
| account_type | RQD | STR | “CA” – Use Card Payee Verify and Process Methods / “BP” – Use Biller Payee Verify and Process Methods |
| request_timestamp | RQD | INT | UNIX timestamp of request |
| participant_unique_id1 | RQD | STR | Echo of participant provided value |
| participant_unique_id2 | OPT | STR | Echo of participant provided value |
| time | RQD | STR | Time in seconds to complete the request |
{
"status": 100,
"client_message": "Success",
"data": {
"count": 2,
"issuers": [{
"payee_id": "123456",
"payee_name": "FirstService Residential",
"payee_address": "PO Box 4444",
"payee_city": "Seattle",
"payee_state": "WA",
"payee_zip": "98101-4972",
"min": "5.00",
"max": "2000.00",
"card_type": "NA",
"issuing_network": "NA",
"estimated_posting_time": "Payment will post 04/17/2020\n",
"estimated_posting_date": "04/17/2020",
"account_type": "BP"
},
{
"payee_id": "123457",
"payee_name": "First Service Middle Jersey",
"payee_address": "PO Box 5555",
"payee_city": "Secaucus",
"payee_state": "NJ",
"payee_zip": "07032-0310",
"min": "5.00",
"max": "2000.00",
"card_type": "NA",
"issuing_network": "NA",
"estimated_posting_time": "Payment will post 04/17/2020\n",
"estimated_posting_date": "04/17/2020",
"account_type": "BP"
}
],
"request_timestamp": 1587050949,
"participant_unique_id1": "f8f68709-8e5d-4c19-8ca0-2eaffef4ec57",
"participant_unique_id2": "257b5bae-d52f-42e2-8f2c-0700d8d7a7a5"
},
"time": "1.8152"
}