Skip to main content
POST
/
gateway
/
process--check
Push funds via check by mail
curl --request POST \
  --url https://payapi-sandbox.ingo.money/gateway/process--check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participant_id": 12345,
  "account_type": "CK",
  "amount": 500,
  "source_of_funds": 4,
  "participant_unique_id1": "35a792a5-39e6-46fa-add1-419a75d3aa9a",
  "timestamp": 1597862420,
  "version": 11,
  "customer_account_token": "6218c726-3989-40ab-af84-fa6f4c932cb6",
  "recipient_phone": "5555550100",
  "participant_unique_id2": "2d4ebd46-616b-4212-bc54-1f7f68514e1a",
  "check_memo_data": "Invoice #12345",
  "remittance_memo_data": "Payment for services rendered Q2 2026",
  "store_id": "STORE-001",
  "clerk_id": "CLK-007",
  "terminal_id": "TERM-042",
  "ledger": {
    "api_key": "lk_live_abc123xyz",
    "user_id": "usr_00456",
    "entity_type": "program",
    "entity_id": "ent_00789"
  }
}
'
{
  "status": 100,
  "client_message": "Success",
  "data": {
    "check_number": "100042",
    "transaction_id": 2361540,
    "customer_account_token": "6218c726-3989-40ab-af84-fa6f4c932cb6",
    "estimated_posting_date": "08/29/2020",
    "estimated_posting_time": "Payment will post 7-10 Days",
    "participant_unique_id1": "35a792a5-39e6-46fa-add1-419a75d3aa9a",
    "participant_unique_id2": "2d4ebd46-616b-4212-bc54-1f7f68514e1a",
    "request_timestamp": 1597862480
  }
}

Body

application/json
​
participant_id
integer
required

Unique participant identifier assigned by Ingo.

Example:

12345

​
account_type
enum<string>
required

Always CK for check by mail disbursements.

Available options:
CK
Minimum string length: 1
Example:

"CK"

​
amount
number<float>
required

Amount of the transaction.

Required range: x >= 0.01
Example:

500

​
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:

"35a792a5-39e6-46fa-add1-419a75d3aa9a"

​
timestamp
integer<int64>
required

Unix timestamp of the request.

Example:

1597862420

​
version
integer
required

API version of the request. Current version is 11.

Example:

11

​
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 - 255
Example:

"6218c726-3989-40ab-af84-fa6f4c932cb6"

​
recipient_phone
string | null

Recipient phone number.

Maximum string length: 25
Example:

"5551234567"

​
participant_unique_id2
string | null

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

Maximum string length: 255
Example:

"2d4ebd46-616b-4212-bc54-1f7f68514e1a"

​
check_memo_data
string | null

Optional memo line printed on the check. Maximum 30 characters.

Maximum string length: 30
Example:

"Invoice #12345"

​
remittance_memo_data
string | null

Optional remittance memo data included with the check mailing. Maximum 193 characters.

Maximum string length: 193
Example:

"Payment for services rendered Q2 2026"

​
store_id
string | null

Client assigned store ID. Required for Retail client participants.

Maximum string length: 255
Example:

"STORE-001"

​
clerk_id
string | null

Client assigned clerk ID. Required for Retail client participants.

Maximum string length: 255
Example:

"CLK-007"

​
terminal_id
string | null

Client assigned terminal ID. Required for Retail client participants.

Maximum string length: 255
Example:

"TERM-042"

​
ledger
object

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

Response

Payment accepted successfully

​
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