Debit Process — ACH - Ingo Payments Developer Hub

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

request

object

required

General information associated with the API request.

Hide child attributes

request.participant_id

string

required

Unique participant identifier assigned by Ingo.

Maximum string length: 5

Example:

"12345"

request.timestamp

string

required

Unix timestamp of the request.

Maximum string length: 32

Example:

"1547143063"

transaction

object

required

General transaction information for the pull request.

Hide child attributes

transaction.account_type

enum<string>

required

Determines the payment rail. AC = Standard ACH, SD = Same-Day ACH.

Available options:

AC,

SD

Minimum string length: 1

Example:

"AC"

transaction.transaction_amount

object

required

Hide child attributes

transaction.transaction_amount.currency_code

string

required

3-character ISO-4217 (alpha) currency code.

Required string length: 3

Pattern: ^[A-Z]{3}$

Example:

"USD"

transaction.transaction_amount.amount

string

required

Amount in the currency indicated by currency_code. Must be greater than 0 with a maximum of 2 decimal places.

Maximum string length: 12

Example:

"101.96"

transaction.participant_unique_ids

object

required

Hide child attributes

transaction.participant_unique_ids.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 pull request. Appears on daily reconciliation reports.

Required string length: 1 - 100

Example:

"eba1fff2-b74b-401f-957e-cc8a16c49408"

transaction.participant_unique_ids.participant_unique_id2

string | null

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

Maximum string length: 100

Example:

"cd5f2b0c-69be-458d-a3a5-5f96cf5171df"

transaction.customer_account_token

string

required

Token representing the account number and customer data as provided in the response from a previous Verify API call.

Required string length: 1 - 254

Example:

"4153e416-d81d-4420-a494-9feceed4eef3"

transaction.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

transaction.recipient_phone

string | null

10-digit recipient phone number.

Pattern: ^[0-9]{10}$

Example:

"4045550100"

transaction.additional_detail

object

Additional transaction details specific to ACH. For ACH transactions, source_name and descriptive_purpose have a combined maximum of 21 characters.

Hide child attributes

transaction.additional_detail.source_name

string | null

Name of the transaction source as easily recognizable to the receiver. The first 10 characters are always accepted — additional characters may be truncated depending on the length of descriptive_purpose.

Maximum string length: 50

Example:

"CorpDisb"

transaction.additional_detail.descriptive_purpose

string | null

Description of the purpose of the transaction. The first 11 characters are always accepted — additional characters may be truncated depending on the length of source_name.

Maximum string length: 50

Example:

"Reimbursement"

transaction.risk_assessment_token

string | null

Associated risk assessment token returned by a prior RiskScore (/risk/riskscore/v2) response. Required when the client is configured to use the Ingo Risk API.

Maximum string length: 36

Example:

"36f6b449-fa29-4f9e-919f-ad1e6433f1d5"

transaction.store

object

Retail store information. Required when the client is configured as a retail participant (retail flag enabled on client debit configuration).

Hide child attributes

transaction.store.store_id

string

required

Client assigned store ID.

Required string length: 1 - 254

Example:

"STORE-001"

transaction.store.clerk_id

string

required

Client assigned clerk ID.

Required string length: 1 - 254

Example:

"CLK-007"

transaction.store.terminal_id

string

required

Client assigned terminal ID.

Required string length: 1 - 254

Example:

"TERM-042"

transaction.card_track

object

Card track data captured at point of sale. Required when the client is configured as a retail participant (retail flag enabled on client debit configuration).

Hide child attributes

transaction.card_track.track1

string

required

URL-encoded Track 1 data from and including the beginning sentinel to and including the ending sentinel.

Maximum string length: 255

Pattern: ^(%B)([0-9]{12,22})([/^])([\s\S]*)([/^])([0-9]{2})([0-9]{2})([0-9]*)([?])$

Example:

"%B4111111111111111^ROCKETS/JOHNNY^2612101000000000000000000000000?"

transaction.card_track.track2

string

required

Track 2 data from and including the beginning sentinel to and including the ending sentinel.

Maximum string length: 255

Pattern: ^(;)([0-9]{12,22})(=)([0-9]{2})([0-9]{2})([0-9])*([?])$

Example:

";4111111111111111=26121010000000000000?"

retail_location

object

Client assigned retail location information. Required when the client is configured with the retail location flag (retail_object flag enabled on client debit configuration). This flag is independent of the retail flag — confirm with your Ingo integration manager.

Hide child attributes

retail_location.location_name

string

required

Client assigned retail location name.

Required string length: 1 - 150

Example:

"ABC Retail"

retail_location.location_id

string

required

Client assigned retail location ID.

Required string length: 1 - 150

Example:

"LOC-1234"

retail_location.location_address

string

required

Client assigned retail location address.

Required string length: 1 - 150

Example:

"456 Retail St."

retail_location.location_city

string

required

Client assigned retail location city.

Required string length: 1 - 150

Example:

"Atlanta"

retail_location.location_state

string

required

Client assigned retail location 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"

retail_location.location_zip

string

required

Client assigned retail location zip code.

Required string length: 1 - 10

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

Example:

"30333"

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"

sender

object

Data about the transaction sender. Required for clients using certain sender-funded transaction configurations.

Hide child attributes

sender.name_personal

object

Personal name of the sender.

Hide child attributes

sender.name_personal.first_name

string

required

Sender first name.

Maximum string length: 150

Example:

"Alex"

sender.name_personal.last_name

string

required

Sender last name.

Maximum string length: 150

Example:

"Rivera"

sender.contact_address

object

Address of the sender.

Hide child attributes

sender.contact_address.address1

string

required

Street address line 1.

Maximum string length: 150

Example:

"100 Innovation Way"

sender.contact_address.city

string

required

City.

Maximum string length: 150

Example:

"Anytown"

sender.contact_address.state

string

required

State (standard two-letter postal abbreviation).

Maximum string length: 2

Example:

"GA"

sender.contact_address.zip

string

required

ZIP code (5-digit or zip+4 format).

Maximum string length: 10

Example:

"00000"

sender.contact_address.address2

string

Street address line 2 (optional).

Maximum string length: 150

sender.contact_telcom

object

Telecommunications contact points for the sender.

Hide child attributes

sender.contact_telcom.email

string

required

Email address.

Maximum string length: 150

Example:

"sender@example.com"

sender.contact_telcom.phone_home

string

Home phone number. Digits only.

Maximum string length: 10

Example:

"5555550100"

sender.contact_telcom.phone_mobile

string

Mobile phone number. Digits only.

Maximum string length: 10

Example:

"5555550101"

retail

object

Retail store information. Required for clients using retail card-present configuration.

Hide child attributes

retail.location_address

string

Retail location street address.

Maximum string length: 150

Example:

"100 Innovation Way"

retail.location_city

string

Retail location city.

Maximum string length: 150

Example:

"Anytown"

retail.location_state

string

Retail location state.

Maximum string length: 2

Example:

"GA"

retail.location_zip

string

Retail location ZIP code.

Maximum string length: 10

Example:

"00000"

sender_account

string

Sender account identifier. Required for sender-funded debit transactions.

Maximum string length: 100

Example:

"SENDER-ACCT-001"

Response

Pull payment accepted successfully

request

object

Echo of the request envelope.

Hide child attributes

request.participant_id

string

Echo of participant ID from request.

Example:

"12345"

request.timestamp

string

Echo of timestamp from request.

Example:

"1547143063"

response

object

Outcome of the API call.

Hide child attributes

response.status

string

Numeric code describing the status of the API request. 100 = Success.

Example:

"100"

response.message

string

Text description associated with the status code.

Example:

"Success"

response.duration

string

Time in seconds to complete the request.

Example:

"1.1809"

transaction

object

Transaction outcome data.

Hide child attributes

transaction.estimated_posting_date

string

Provided on success. Estimated posting date.

Example:

"04/23/2026"

transaction.estimated_posting_time

string

Provided on success. Estimated posting time narrative.

Example:

"Payment will post 04/23/2026"

transaction.transaction_id

string | null

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

Example:

"1237775"

transaction.customer_account_token

string

Echo of value from request. Provided on success.

Example:

"4153e416-d81d-4420-a494-9feceed4eef3"

transaction.participant_unique_ids

object

Echo of participant IDs from request.

Hide child attributes

transaction.participant_unique_ids.participant_unique_id1

string

Echo of participant_unique_id1 from request.

Example:

"eba1fff2-b74b-401f-957e-cc8a16c49408"

transaction.participant_unique_ids.participant_unique_id2

string | null

Echo of participant_unique_id2 from request if provided.

Example:

"cd5f2b0c-69be-458d-a3a5-5f96cf5171df"

Overview

Verify

Process

Debit

Risk

Ancillary

Webhooks

Debit Process — ACH

Authorizations

Body

Response

Overview

Verify

Process

Debit

Risk

Ancillary

Webhooks

Documentation Index

Authorizations

Body

Response