Process

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

participant_id

integer

required

Unique participant identifier assigned by Ingo.

Example:

12345

account_type

enum<string>

required

Always CA for card-based (debit or credit) disbursements.

Available options:

CA

Minimum string length: 1

Example:

"CA"

amount

number<float>

required

Amount of the transaction.

Required range: x >= 0.01

Example:

1010.5

customer_account_token

string

required

Token representing the account number and customer data as provided in the response from a previous Verify API call. When provided, raw account fields (account, expiration_date, recipient_first_name, recipient_last_name, recipient_address1, recipient_city, recipient_state, recipient_zip) must be omitted.

Required string length: 1 - 255

Example:

"ca875cce-58c0-46a0-8f14-676190cc7df6"

source_of_funds

enum<integer>

required

Funding source indicator: 1 = Cash, 2 = Check, 3 = Combo of Cash & Check, 4 = Corp Disbursement.

Available options:

1,

2,

3,

4

Example:

4

participant_unique_id1

string

required

Participant assigned transaction ID for the process request. Value must be unique and may not contain NPI data. Used for idempotency — a duplicate value returns an idempotent response without initiating a new push request. Appears on daily reconciliation reports.

Required string length: 1 - 255

Example:

"1f2739ed-3531-4af2-ae36-e6faf7936462"

timestamp

integer<int64>

required

Unix timestamp of the request.

Example:

1576099257

version

integer

required

API version of the request. Current version is 11.

Example:

11

recipient_phone

string

10-digit recipient phone number.

Maximum string length: 10

Example:

"1231231234"

participant_unique_id2

string | null

Optional second participant assigned transaction ID. Does not appear on daily reconciliation reports.

Maximum string length: 255

Example:

"90759390-01c7-47e7-8a90-6faa89b18ff6"

sender

object

Data about the transaction sender. Required for clients using sender data.

Hide child attributes

sender.sender_account

string

required

Sender account identifier.

Required string length: 1 - 100

Example:

"ACC-00123456"

sender.name_personal

object

required

Hide child attributes

sender.name_personal.first_name

string

required

Sender first name.

Required string length: 1 - 150

Example:

"Jane"

sender.name_personal.last_name

string

required

Sender last name.

Required string length: 1 - 150

Example:

"Doe"

sender.contact_address

object

required

Hide child attributes

sender.contact_address.address1

string

required

Street address line 1.

Required string length: 1 - 150

Example:

"123 Main St"

sender.contact_address.city

string

required

City.

Required string length: 1 - 150

Example:

"Atlanta"

sender.contact_address.state

string

required

State (standard US postal abbreviation).

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"

sender.contact_address.zip

string

required

5-digit zip or zip+4 in xxxxx-xxxx format.

Maximum string length: 10

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

Example:

"30313"

sender.contact_address.address2

string | null

Optional street address line 2 (e.g. Apt, Suite).

Maximum string length: 150

Example:

"Apt 4B"

sender.contact_telcom

object

required

Hide child attributes

sender.contact_telcom.email

string

required

Sender email address.

Required string length: 1 - 150

Example:

"jane.doe@example.com"

sender.contact_telcom.phone_home

string | null

Home phone number.

Maximum string length: 10

Example:

"4045550100"

sender.contact_telcom.phone_mobile

string | null

Mobile phone number.

Maximum string length: 10

Example:

"4045550101"

ledger

object

Required for clients configured for ledger service. Exclude entirely if not applicable to your integration.

Hide child attributes

ledger.api_key

string

required

API key associated with the ledger program.

Required string length: 1 - 100

Example:

"lk_live_abc123xyz"

ledger.user_id

string

required

User ID associated with the ledger program.

Required string length: 1 - 100

Example:

"usr_00456"

ledger.entity_type

enum<string>

required

Entity type for the ledger. Accepted values: program, business, user.

Available options:

program,

business,

user

Required string length: 1 - 50

Example:

"program"

ledger.entity_id

string | null

required

Entity ID associated with the ledger.

Maximum string length: 100

Example:

"ent_00789"

store_id

string

Client-assigned store ID. Required if participant is configured for retail card-present.

Maximum string length: 255

Example:

"STORE-001"

terminal_id

string

Client-assigned terminal ID. Required if participant is configured for retail card-present.

Maximum string length: 255

Example:

"TERM-001"

clerk_id

string

Client-assigned clerk ID. Required if participant is configured for retail card-present.

Maximum string length: 255

Example:

"CLERK-001"

Response

Payment accepted successfully

status

integer

Numeric code describing the status of the API request. 100 = Success, 102 = Success - Pending Issuer Response, 130 = Success - OFAC Suspended.

Example:

100

client_message

string

Text description associated with the status code.

Example:

"Success"

data

object

Hide child attributes

data.estimated_posting_time

string

Provided on success. Estimated posting time of the payment.

Example:

"Payment will post within 5 minutes."

data.estimated_posting_date

string

Provided on success. Estimated posting date of the payment.

Example:

"04/21/2026"

data.transaction_id

integer

Always provided on success and in certain failure conditions. Unique transaction identifier generated with each successful request. Log this value — Ingo Payment Services will request it for support interactions.

Example:

2361525

data.request_timestamp

integer<int64>

Unix timestamp of the request.

Example:

1576099632

data.customer_account_token

string

Echo of value from request. Provided on success.

Example:

"ca875cce-58c0-46a0-8f14-676190cc7df6"

data.participant_unique_id1

string

Always provided on success and in certain failure conditions. Echo of value provided on request.

Example:

"1f2739ed-3531-4af2-ae36-e6faf7936462"

data.participant_unique_id2

string | null

Provided on success and in certain failure conditions if sent on original request. Echo of value provided on request.

Example:

"90759390-01c7-47e7-8a90-6faa89b18ff6"

time

string

Time in seconds to complete the request.

Example:

"1.1275"

Overview

Verify

Debit

Risk

Ancillary

Webhooks

Process — Card

Authorizations

Body

Response

Overview

Verify

Process

Debit

Risk

Ancillary

Webhooks

Documentation Index

Authorizations

Body

Response