Verify — BillPay - Ingo Payments Developer Hub

Authorizations

Authorization

string

header

required

HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.

Body

application/json

Provide either customer_account_token or the raw account fields (account, recipient_first_name, recipient_last_name, recipient_address1, recipient_city, recipient_state, recipient_zip) — never both.

participant_id

integer

required

Unique participant identifier assigned by Ingo.

Example:

12345

payee_id

string

required

Ingo assigned payee ID for the selected biller. Obtain from the Biller Payments Search API prior to calling Verify.

Maximum string length: 40

Example:

"123457"

timestamp

integer<int64>

required

Unix timestamp of the request.

Example:

1587052132

version

integer

required

API version of the request. Current version is 11.

Example:

11

participant_unique_id1

string

required

Participant assigned ID to be associated with customer_account_token creation. Should correlate to participant assigned values affiliated with future process requests for tracking purposes (e.g. CustomerID or AccountID). Must not contain NPI data.

Required string length: 1 - 255

Example:

"f8f68709-8e5d-4c19-8ca0-2eaffef4ec57"

account_type

enum<string>

required

Always BP for bill payment transactions.

Available options:

BP

Minimum string length: 1

Example:

"BP"

customer_account_token

string | null

Alternative to raw account data when the account was previously tokenized. If provided, the following fields are not required and should be omitted: account, recipient_first_name, recipient_last_name, recipient_address1, recipient_city, recipient_state, recipient_zip.

Required string length: 1 - 255

Example:

"a74eacf4-32e8-4081-b69c-565a89dd6cf1"

account

string

Customer bill payment account number. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255

Example:

"12345678"

recipient_first_name

string

Customer first name. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255

Example:

"Johnny"

recipient_last_name

string

Customer last name. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255

Example:

"Rockets"

recipient_business_name

string | null

Optional recipient business name.

Maximum string length: 150

Example:

"Rockets LLC"

recipient_address1

string

Customer billing address line 1. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255

Example:

"123 Main St"

recipient_city

string

Customer billing city. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255

Example:

"Atlanta"

recipient_state

string

Customer billing state (standard US postal abbreviation). Required unless a valid customer_account_token is provided.

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"

recipient_zip

string

Customer billing zip code. 5-digit zip or zip+4 in xxxxx-xxxx format. Required unless a valid customer_account_token is provided.

Maximum string length: 10

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

Example:

"30313"

recipient_address2

string | null

Customer billing address line 2.

Maximum string length: 255

Example:

"Apt 2"

recipient_email

string | null

Optional recipient email address.

Maximum string length: 255

Example:

"johnny.rockets@example.com"

recipient_phone

string | null

10-digit recipient phone number.

Maximum string length: 10

Example:

"1231231234"

participant_unique_id2

string | null

Optional second participant assigned ID to be associated with customer_account_token creation. Should be carried forward to future process requests for tracking purposes. Must not contain NPI data.

Maximum string length: 255

Example:

"257b5bae-d52f-42e2-8f2c-0700d8d7a7a5"

amount

number<float> | null

Dollar amount of disbursement. Max value determined by participant velocity limits.

Required range: x >= 0.01

Example:

1010.5

Response

Verification successful — token returned

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

Show child attributes

time

string

Time in seconds to complete the request.

Example:

"1.6832"