Verify

Authorizations

Authorization

string

header

required

All requests must be authenticated using an HMAC-signed Authorization header. Ingo Money requires HMAC-SHA512 for all new integrations. SHA-512 provides a significantly larger internal state and output length than SHA-256, making it substantially more resistant to length-extension attacks and brute-force preimage attempts — properties that matter for financial API traffic where each request authorizes a real money movement.

Legacy integrations using HMAC-SHA256 remain supported but are encouraged to upgrade. SHA-256 continues to meet the current minimum security bar; however, upgrading to SHA-512 eliminates an entire class of potential vulnerabilities before they become exploitable, and aligns with NIST guidance recommending SHA-2 family algorithms with 256-bit security strength or greater for long-term use. Contact your Ingo integration manager to coordinate an algorithm upgrade.

MD5 and SHA-1 are not accepted under any circumstances. Requests signed with either algorithm will be rejected.

Authorization header format:

Authorization: hmac username="YOUR_HMAC_USERNAME", algorithm="hmac-sha512", headers="request-line x-date content-type content-length content-sha512", signature="BASE64_SIGNATURE"

Credentials provisioned by your Ingo integration manager:

HMAC username — identifies your integration in the Authorization header username field. Distinct from your participant identifier.
HMAC secret — provisioned by your Ingo integration manager. The private key used to compute the signature. Never transmit this value — store it in a secrets manager or environment variable, never in source code.
Participant identifier — a separate value used to identify your account within the API request payload. The name and placement differs by product family. Both the HMAC username and participant identifier are provisioned at onboarding — do not substitute one for the other.
API key — required for select product families as an additional per-request credential. See product-specific documentation for applicability.

See the Ingo API Authentication Guide for the complete string-to-sign construction, body hashing requirements, and timestamp validation rules.

Body

application/json

Provide either customer_account_token or the full set of raw account fields (account, receiver_type, 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

account_type

enum<string>

required

Indicates the type of transaction. PU = PayPal unverified account payout transaction, VE = Venmo payout transaction.

Available options:

PU,

VE

Minimum string length: 1

Example:

"PU"

participant_unique_id1

string

required

Participant assigned ID for the disbursement. Should be carried forward to the process request for tracking purposes. Must not contain NPI data.

Required string length: 1 - 254

Example:

"5ced00c4-116d-4786-b1cd-016f7f23dc54"

timestamp

integer<int64>

required

Unix timestamp of the request.

Example:

1598505599

version

integer

required

API version of the request. Current version is 11.

Example:

11

receiver_type

enum<integer>

Required when customer_account_token is not provided. Determines how the account value is interpreted. 1 = EMAIL, 2 = PHONE, 3 = PAYPAL_ID (PayPal PU only), 4 = USER_HANDLE (Venmo VE only).

Available options:

1,

2,

3,

4

Example:

1

customer_account_token

string | null

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

Required string length: 1 - 254

Example:

"a3650c4f-60e3-4f80-ba4b-b79055e20007"

account

string

Value used to identify the receiving account. Required unless customer_account_token is provided. Interpretation depends on receiver_type: EMAIL address, phone number, PayPal ID, or Venmo user handle.

Required string length: 1 - 254

Example:

"jane.doe@example.com"

recipient_first_name

string

Recipient first name. Required unless customer_account_token is provided.

Required string length: 1 - 254

Example:

"Jane"

recipient_last_name

string

Recipient last name. Required unless customer_account_token is provided.

Required string length: 1 - 254

Example:

"Doe"

recipient_address1

string

Recipient address line 1. Required unless customer_account_token is provided.

Required string length: 1 - 254

Example:

"123 Main St"

recipient_city

string

Recipient city. Required unless customer_account_token is provided.

Required string length: 1 - 254

Example:

"Atlanta"

recipient_state

string

Recipient state (standard US postal abbreviation). Required unless 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 | null

Recipient zip code. 5-digit zip or zip+4 in xxxxx-xxxx format. Required unless customer_account_token is provided.

Maximum string length: 10

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

Example:

"30313"

recipient_address2

string | null

Optional recipient address line 2.

Maximum string length: 254

Example:

"Apt 2"

recipient_business_name

string | null

Optional recipient business name.

Maximum string length: 150

Example:

"Doe Enterprises"

recipient_phone

string | null

Optional 10-digit recipient phone number.

Maximum string length: 10

Example:

"5551234567"

recipient_email

string | null

Optional recipient email address.

Maximum string length: 254

Example:

"jane.doe@example.com"

amount

number<float> | null

Dollar amount of disbursement.

Required range: x >= 0.01

Example:

50.01

participant_unique_id2

string | null

Optional second participant assigned ID for the disbursement. This value should be the same on all activity pertaining to a disbursement attempt.

Maximum string length: 254

Example:

"4259cf7e-ffd2-414a-9c82-cca8a4613e69"

store_id

string | null

Client assigned store ID. Required for Retail client participants.

Maximum string length: 254

Example:

"STORE-001"

terminal_id

string | null

Client assigned terminal ID. Required for Retail client participants.

Maximum string length: 254

Example:

"TERM-042"

clerk_id

string | null

Client assigned clerk ID. Required for Retail client participants.

Maximum string length: 254

Example:

"CLK-007"

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"

recipient_message

string

Text description associated with the status code for the recipient.

Example:

"Success"

data

object

Hide child attributes

data.customer_account_token

string

GUID — unique value generated per API call request. Use this token in all subsequent Process requests for this account.

Example:

"a3650c4f-60e3-4f80-ba4b-b79055e20007"

data.last_4

string

The last 4 characters of the account value.

Example:

"k6Aw"

data.expiration_date

string | null

Expiration date associated with the account, if applicable. Returns empty string for PayPal and Venmo accounts.

Example:

""

data.request_timestamp

integer<int64>

Unix timestamp of the request.

Example:

1598505603

data.issuers

object[]

Information about the issuer of the account.

Hide child attributes

data.issuers.payee_id

string

The Ingo assigned ID for the payee.

Example:

"614004"

data.issuers.payee_name

string

Name of payee.

Example:

"Paypal"

data.issuers.payee_address

string | null

Payee address.

Example:

""

data.issuers.payee_city

string | null

Payee city.

Example:

""

data.issuers.payee_state

string | null

Payee state.

Example:

""

data.issuers.payee_zip

string | null

Payee zip code.

Example:

""

data.issuers.credit_info

object

Information regarding limits for push (credit) transactions. Returned if participant is enabled for push processing.

Hide child attributes

data.issuers.credit_info.min

string

Minimum amount accepted for a push transaction.

Example:

"0.01"

data.issuers.credit_info.max

string

Maximum amount accepted for a push transaction.

Example:

"10000.00"

data.issuers.credit_info.card_type

string

Account type identifier. Returns NA for PayPal and Venmo accounts.

Example:

"NA"

data.issuers.credit_info.estimated_posting_time

string

Estimated posting time narrative.

Example:

"Payment will post within 5 minutes."

data.issuers.credit_info.estimated_posting_date

string

Estimated posting date.

Example:

"04/21/2026"

data.issuers.issuing_network

string

Issuing network identifier. Returns NA for PayPal and Venmo accounts.

Example:

"NA"

data.issuers.credit_enabled

enum<integer>

Whether the account is enabled for push (credit) transactions. 1 = Enabled, 0 = Not enabled.

Available options:

0,

1

Example:

1

data.issuers.debit_enabled

enum<integer>

Whether the account is enabled for pull (debit) transactions. 1 = Enabled, 0 = Not enabled.

Available options:

0,

1

Example:

0

data.issuers.velocity

string

Estimated transaction posting date-time attribute assigned by Ingo.

Example:

"2026-04-30T12:00:00Z"

data.participant_unique_id1

string

Participant assigned ID for the verify request. Should be carried forward to the process request for tracking purposes.

Example:

"5ced00c4-116d-4786-b1cd-016f7f23dc54"

data.participant_unique_id2

string | null

Optional second participant assigned ID for the verify request. Can also be carried forward to the process request for tracking purposes.

Example:

"4259cf7e-ffd2-414a-9c82-cca8a4613e69"

data.count

integer

Always returns 1.

Example:

1

time

string

Time in seconds to complete the request.

Example:

"2.4577"

validation_errors

string | null

Provides additional detail on validation type errors when applicable.

Example:

null

Overview

Process

Debit

Risk

Ancillary

Webhooks

Verify — PayPal / Venmo

Authorizations

Body

Response

Overview

Verify

Process

Debit

Risk

Ancillary

Webhooks

Documentation Index

Authorizations

Body

Response