Verify — Check by Mail - Ingo Payments Developer Hub

curl --request POST \ --url https://payapi-sandbox.ingo.money/gateway/verify--check \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "participant_id": 12345, "account_type": "CK", "recipient_is_beneficiary": 1, "recipient": { "recipient_line1": "Ace Ventura", "recipient_address1": "100 Innovation Way", "recipient_address2": "Apt 3", "recipient_city": "Anytown", "recipient_state": "GA", "recipient_zip": "00000", "recipient_phone": "5555550100" }, "beneficiary": { "beneficiary_account": "3000000038", "beneficiary_first_name": "Alex", "beneficiary_last_name": "Rivera", "beneficiary_address1": "100 Innovation Way", "beneficiary_address2": "", "beneficiary_city": "Anytown", "beneficiary_state": "GA", "beneficiary_zip": "00000", "beneficiary_phone": "5555550100" }, "participant_unique_id1": "35a792a5-39e6-46fa-add1-419a75d3aa9a", "participant_unique_id2": "2d4ebd46-616b-4212-bc54-1f7f68514e1a", "timestamp": 1597862420, "version": 11 } '

{ "status": 100, "client_message": "Success", "data": { "customer_account_token": "6218c726-3989-40ab-af84-fa6f4c932cb6", "last_4": "0038", "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": 1597867738 }, "time": "1.4295" }

Authorizations

Authorization

string

header

required

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

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

Available options:

CK

Minimum string length: 1

Example:

"CK"

recipient

object

required

Information about the recipient (payee) of the check — used for the pay-to line and mailing address. Required when recipient_is_beneficiary = 0. When recipient_is_beneficiary = 1, this object is auto-populated from beneficiary fields and may be omitted.

Show child attributes

recipient_is_beneficiary

enum<integer>

required

Flag indicating whether the recipient is the beneficiary. 1 = Recipient is the beneficiary (default). 0 = Recipient is not the beneficiary — a separate recipient mailing address must be provided.

Available options:

0,

1

Example:

1

beneficiary

object

required

Information about the beneficiary associated with the payment. Only persistent data should be provided — data that can be used again for payments on the same account. All information provided is included in the remittance data printed and sent with the check. When recipient_is_beneficiary = 1, this information is also used for the pay-to line and mailing address.

Show child attributes

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:

"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

participant_unique_id2

string | null

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

Maximum string length: 255

Example:

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

store_id

string | null

Client assigned store ID. Required for Retail client participants.

Maximum string length: 255

Example:

"STORE-001"

terminal_id

string | null

Client assigned terminal ID. Required for Retail client participants.

Maximum string length: 255

Example:

"TERM-042"

clerk_id

string | null

Client assigned clerk ID. Required for Retail client participants.

Maximum string length: 255

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"

data

object

Show child attributes

time

string

Time in seconds to complete the request.

Example:

"1.4295"

Overview

API Reference

Webhooks

Verify — Check by Mail

Authorizations

Body

Response