Purpose: Submit a request to push funds to a customer's account.
The Process method is used to instruct the IPG platform to disburse funding to a customer's account. The partner and their customer should be committed to the payment prior to making the Process call to the system. A successful response provides verification that the payment item has been accepted. Once accepted, a payment cannot be reversed.
Clients should ASSUME SUCCESS for any Process (payment) requests in which a response has not been received from Ingo Payments. This includes the assumption of normal settlement for these transactions by Ingo Payments. Any consumer funds associated with the transaction should be accounted for by the client aligning with normal successful transaction processing.
Additional information on re-try attemtps and handling timeout scenarios can be reviewed under the >>.>Idempotency section.
Clients should log Ingo Transaction ID, Ingo will request this when interacting with Payment Services Team along with Participant_unique_id1.
Sandbox URL: https://payapi-sandbox.ingo.money/gateway/process
Participants may declare the Content Types below in the request header to ‘Accept’ back as their response format (default is JSON):
HTTP: POST
Content Type: application/json
See Full List of IngoPay API Response Codes here.
Purpose: Submit a request to push funds to a customer Card (debit or credit).
PARAMETER | RQMT | TYPE | MAX_LEN | DESCRIPTION |
---|---|---|---|---|
participant_id | RQD | INT | 5 | Unique participant identifier assigned by Ingo |
account_type | RQD | STR | 2 | Value will always be ‘CA’. |
amount | RQD | DEC | 40 | Amount of the transaction |
customer_account_token | RQD | STR | 255 | Value representing the account number and customer data as provided in response from a previous Verify API call |
source_of_funds | RQD | INT | 1 | Funding source indicator: 1 – Cash, 2 – Check, 3 – Combo of Cash & Check, 4 – Corp Disb |
recipient_phone | OPT | STR | 10 | 10-digit recipient phone. |
participant_unique_id1 | RQD | STR | 255 | Participant assigned transaction ID for the process request. Value must be unique and may not contain NPI data. This value is used to determine whether a request has been previously received and processed successfully; if a request is duplicated, Ingo Payments will send an idempotent response and will NOT initiate a new push request. Value will appear on daily reconciliation reports. |
participant_unique_id2 | OPT | STR | 255 | Optional second participant assigned transaction ID for the request. This ID does not carry forward to daily reconciliation reports. |
sender | COND | OBJ | Data about the transaction sender | |
sender_account | RQD | STR | 100 | Sender account identifier |
name_personal | RQD | OBJ | Personal name associated with the sender | |
first_name | RQD | OBJ | 150 | First Name |
last_name | RQD | OBJ | 150 | Last Name |
contact_address | RQD | OBJ | Address of sender | |
address1 | RQD | STR | 150 | Street Address line 1 |
address2 | OPT | STR | 150 | Optional street address line 2 (e.g., Apt #, Suite #, ect.) |
city | RQD | STR | 150 | City |
state | RQD | STR | 2 | State(standard state abbrevation |
zip | RQD | STR | 10 | Zip code (5-digit zip or 10-digit zip-plus-4 in xxxxx-xxxx format) |
contact_telcom | RQD | OBJ | Party telcom contact points | |
RQD | STR | 150 | Email address | |
phone_home | OPT | STR | 10 | Home phone number |
phone_mobile | OPT | STR | 10 | Mobile phone number |
store_id | COND | STR | 255 | Client assigned store ID. This field is required if participant is a Retail client. |
terminal_id | COND | STR | 255 | Client assigned terminal ID. This field is required if participant is a Retail client. |
clerk_id | COND | STR | 255 | Client assigned clerk ID. This field is required if participant is a Retail client. |
timestamp | RQD | INT | -> | Unix timestamp. |
version | RQD | INT | 2 | API version of the request. Current version is 11. |
{
"participant_id": 12345,
"account_type": "CA",
"amount": "1010.50",
"customer_account_token": "ca875cce-58c0-46a0-8f14-676190cc7df6",
"source_of_funds": 4,
"recipient_phone": "1231231234",
"participant_unique_id1": "1f2739ed-3531-4af2-ae36-e6faf7936462",
"participant_unique_id2": "90759390-01c7-47e7-8a90-6faa89b18ff6",
"timestamp": 1576099257,
"version": 11
}
PARAMETER | RQMT | TYPE | DESCRIPTION |
---|---|---|---|
status | RQD | INT | Numeric code describing status of API request (e.g. 100 = Success). |
client_message | RQD | STR | Text description associated with status code. |
data | RQD | OBJ | Information about identifiers associated with the transaction |
estimated_posting_time | COND | STR | Provided on success. Estimated posting time of the payment: “Your payment will post within 5 minutes.” or “Your payment will post todays date.” or “Your payment will post next business day’s date.” |
estimated_posting_date | COND | STR | Provided on success. Estimated posting time of the payment in date format |
transaction_id | COND | INT | Always provided on success and in certain failure conditions. Unique transaction identifier generated with each successful request. |
request_timestamp | RQD | INT | Unix timestamp. |
customer_account_token | COND | STR | Echo of value from request. Provided on success. |
participant_unique_id1 | COND | STR | Always provided on success and in certain failure conditions. Echo of value provided on request. |
participant_unique_id2 | OPT | STR | Provided on success and in certain failure conditions if sent on original request. Echo of value provided on request. |
time | RQD | STR | Time in seconds to complete the request |
{
"status": 100,
"client_message": "Success",
"data": {
"estimated_posting_time": "Payment post within X mins",
"estimated_posting_date": "XX/XX/20XX",
"transaction_id": 2361525,
"request_timestamp": 1576099632,
"customer_account_token": "ca875cce-58c0-46a0-8f14-676190cc7df6",
"participant_unique_id1": "1f2739ed-3531-4af2-ae36-e6faf7936462",
"participant_unique_id2": "90759390-01c7-47e7-8a90-6faa89b18ff6"
},
"time": "1.1275"
}
{
"status": 102,
"client_message": "Success - Pending Issuer Response",
"data": {
"estimated_posting_time": "Payment post within X mins",
"estimated_posting_date": "XX/XX/20XX",
"transaction_id": 2361525,
"request_timestamp": 1576099632,
"customer_account_token": "ca875cce-58c0-46a0-8f14-676190cc7df6",
"participant_unique_id1": "1f2739ed-3531-4af2-ae36-e6faf7936462",
"participant_unique_id2": "90759390-01c7-47e7-8a90-6faa89b18ff6"
},
"time": "18.7229"
}
{
"status": 130,
"client_message": "Success - OFAC suspended",
"data": {
"transaction_id": 2361525
},
"time": "5.3401"
}
{
"status": 710,
"client_message": "Issuer Declined - Customer should contact card issuer",
"data": {
"request_timestamp": 1610648352
},
"time": "1.6609"
}
Purpose: Submit a request to push funds to a customer's bank account.
PARAMETER | RQMT | TYPE | MAX_LEN | DESCRIPTION |
---|---|---|---|---|
participant_id | RQD | INT | 5 | Unique participant identifier assigned by Ingo. |
customer_account_token | RQD | STR | 255 | Value representing the account number and customer data as provided in response from a previous Verify API call. |
account_type | RQD | STR | 2 | Value should be set to 'AC' for ACH, 'SD' for same-day ACH, or 'RT' for RTP |
amount | RQD | DEC | 40 | Amount of the transaction. |
participant_unique_id1 | RQD | STR | 255 | Participant assigned transaction ID for the process request. Value must be unique and may not contain NPI data. This value is used to determine whether a request has been previously received and processed successfully; if a request is duplicated, Ingo Payments will send an idempotent response and will NOT initiate a new push request. Value will appear on daily reconciliation reports. |
participant_unique_id2 | OPT | STR | 255 | Optional second participant assigned transaction ID for the request. This ID does not carry forward to daily reconciliation reports. |
recipient_phone | OPT | INT | 10 | 10-digit recipient phone number. |
source_of_funds | RQD | STR | 1 | Funding source indicator: 1 – Cash, 2 – Check, 3 – Combo of Cash & Check, 4 – Corp Disbursement |
store_id | COND | STR | 255 | Client assigned store ID. This field is required if participant is a Retail client. |
terminal_id | COND | STR | 255 | Client assigned terminal ID. This field is required if participant is a Retail client. |
clerk_id | COND | STR | 255 | Client assigned clerk ID. This field is required if participant is a Retail client. |
timestamp | RQD | INT | -> | Unix timestamp. |
version | RQD | INT | 2 | Current version is: 11 |
{
"participant_id": 12345,
"account_type": "AC",
"amount": "1010.50",
"customer_account_token": "89421718-a62e-4344-8a1d-4baf73fb11f1",
"source_of_funds": "4",
"recipient_phone": 1231231234,
"participant_unique_id1": "5bf1e2c3-2169-406f-bf1b-f7bc5c2303b3",
"participant_unique_id2": "80525360-dae4-4d0f-9f5c-e09f3fdcf7c8",
"timestamp": 1576100703,
"version": 11
}
PARAMETER | RQMT | TYPE | DESCRIPTION |
---|---|---|---|
status | RQD | INT | Numeric code describing status of API request (e.g. 100 = Success). |
client_message | RQD | STR | Text description associated with status code. |
data | RQD | OBJ | Information about identifiers associated with the transaction |
estimated_posting_time | COND | STR | Provided on success. Estimated posting time of the payment: “Your payment will post within 5 minutes.” or “Your payment will post todays date.” or “Your payment will post next business day’s date.” |
estimated_posting_date | COND | STR | Provided on success. Estimated posting time of the payment in date format |
transaction_id | COND | INT | Always provided on success and in certain failure conditions. Unique transaction identifier generated with each successful request. |
request_timestamp | RQD | INT | Unix timestamp. |
customer_account_token | COND | STR | Echo of value from request. Provided on success. |
participant_unique_id1 | COND | STR | Always provided on success and in certain failure conditions. echo of value provided on request. |
participant_unique_id2 | OPT | STR | Provided on success and in certain failure conditions if sent on original request. Echo of value provided on request. |
time | RQD | STR | Time in seconds to complete the request |
{
"status": 100,
"client_message": "Success",
"data": {
"estimated_posting_date": "XX/XX/20XX",
"estimated_posting_time": "Payment will post XX/XX/20XX",
"transaction_id": 2361537,
"request_timestamp": 1576100772,
"customer_account_token": "89421718-a62e-4344-8a1d-4baf73fb11f1",
"participant_unique_id1": "5bf1e2c3-2169-406f-bf1b-f7bc5c2303b3",
"participant_unique_id2": "80525360-dae4-4d0f-9f5c-e09f3fdcf7c8"
},
"time": "1.3092"
}
Purpose: Submit a request to push funds to a customer's PayPal account.
PARAMETER | RQMT | TYPE | MAX_LEN | DESCRIPTION |
---|---|---|---|---|
participant_id | RQD | INT | 5 | Unique participant identifier assigned by Ingo |
account_type | RQD | STR | 2 | Value will always be ‘PD’. |
amount | RQD | DEC | 40 | Amount of the transaction |
customer_account_token | RQD | STR | 255 | Value representing the account number and customer data as provided in response from a previous Verify API call |
source_of_funds | RQD | INT | 1 | Funding source indicator: 1 – Cash, 2 – Check, 3 – Combo of Cash & Check, 4 – Corp Disb |
recipient_phone | OPT | STR | 10 | 10-digit recipient phone. |
participant_unique_id1 | RQD | STR | 255 | Participant assigned transaction ID for the process request. Value must be unique and may not contain NPI data. This value is used to determine whether a request has been previously received and processed successfully; if a request is duplicated, Ingo Payments will send an idempotent response and will NOT initiate a new push request. Value will appear on daily reconciliation reports. |
participant_unique_id2 | OPT | STR | 255 | Optional second participant assigned transaction ID for the request. This ID does not carry forward to daily reconciliation reports. |
store_id | COND | STR | 255 | Client assigned store ID. This field is required if participant is a Retail client. |
terminal_id | COND | STR | 255 | Client assigned terminal ID. This field is required if participant is a Retail client. |
clerk_id | COND | STR | 255 | Client assigned clerk ID. This field is required if participant is a Retail client. |
timestamp | RQD | INT | -> | Unix timestamp. |
version | RQD | INT | 2 | API version of the request. Current version is 11. |
{
"participant_id": 12345,
"account_type": "PD",
"amount": "1010.50",
"customer_account_token": "ca875cce-58c0-46a0-8f14-676190cc7df6",
"source_of_funds": 4,
"recipient_phone": "1231231234",
"participant_unique_id1": "1f2739ed-3531-4af2-ae36-e6faf7936462",
"participant_unique_id2": "90759390-01c7-47e7-8a90-6faa89b18ff6",
"timestamp": 1576099257,
"version": 11
}
PARAMETER | RQMT | TYPE | DESCRIPTION |
---|---|---|---|
status | RQD | INT | Numeric code describing status of API request (e.g. 100 = Success). |
client_message | RQD | STR | Text description associated with status code. |
data | RQD | OBJ | Information about identifiers associated with the transaction |
estimated_posting_time | COND | STR | Provided on success. Estimated posting time of the payment: “Your payment will post within 5 minutes.” or “Your payment will post todays date.” or “Your payment will post next business day’s date.” |
estimated_posting_date | COND | STR | Provided on success. Estimated posting time of the payment in date format |
transaction_id | COND | INT | Always provided on success and in certain failure conditions. Unique transaction identifier generated with each successful request. |
request_timestamp | RQD | INT | Unix timestamp. |
customer_account_token | COND | STR | Echo of value from request. Provided on success. |
participant_unique_id1 | COND | STR | Always provided on success and in certain failure conditions. Echo of value provided on request. |
participant_unique_id2 | OPT | STR | Provided on success and in certain failure conditions if sent on original request. Echo of value provided on request. |
time | RQD | STR | Time in seconds to complete the request |
{
"status": 100,
"client_message": "Success",
"data": {
"estimated_posting_time": "Payment post within X mins",
"estimated_posting_date": "XX/XX/20XX",
"transaction_id": 2361525,
"request_timestamp": 1576099632,
"customer_account_token": "ca875cce-58c0-46a0-8f14-676190cc7df6",
"participant_unique_id1": "1f2739ed-3531-4af2-ae36-e6faf7936462",
"participant_unique_id2": "90759390-01c7-47e7-8a90-6faa89b18ff6"
},
"time": "1.1275"
}
{
"status": 102,
"client_message": "Success - Pending Issuer Response",
"data": {
"estimated_posting_time": "Payment post within X mins",
"estimated_posting_date": "XX/XX/20XX",
"transaction_id": 2361525,
"request_timestamp": 1576099632,
"customer_account_token": "ca875cce-58c0-46a0-8f14-676190cc7df6",
"participant_unique_id1": "1f2739ed-3531-4af2-ae36-e6faf7936462",
"participant_unique_id2": "90759390-01c7-47e7-8a90-6faa89b18ff6"
},
"time": "18.7229"
}
{
"status": 130,
"client_message": "Success - OFAC suspended",
"data": {
"transaction_id": 2361525
},
"time": "5.3401"
}
{
"status": 710,
"client_message": "Issuer Declined - Customer should contact card issuer",
"data": {
"request_timestamp": 1610648352
},
"time": "1.6609"
}
Purpose: Submit a request to generate a BillPay (non-card) payment.
PARAMETER | RQMT | TYPE | MAX_LEN | DESCRIPTION |
---|---|---|---|---|
participant_id | RQD | STR | 5 | Unique participant identifier assigned by Ingo |
account_type | RQD | STR | 2 | For non-card Bill Pay disbursements the value should be set to “BP”. |
amount | RQD | DEC | 40 | Amount of the transaction |
customer_account_token | RQD | STR | 255 | Value representing the account number and customer data as provided in response from a previous Verify API call |
source_of_funds | RQD | INT | 1 | Funding source indicator: 1 – Cash, 2 – Check, 3 – Combo of Cash & Check, 4 – Corp Disb |
recipient_phone | OPT | STR | 10 | 10-digit recipient phone. |
participant_unique_id1 | RQD | STR | 255 | Participant assigned transaction ID for the process request. Value must be unique and may not contain NPI data. This value is used to determine whether a request has been previously received and processed successfully; if a request is duplicated, Ingo Payments will send an idempotent response and will NOT initiate a new push request. Value will appear on daily reconciliation reports. |
participant_unique_id2 | OPT | STR | 255 | Optional second participant assigned transaction ID for the request. This ID does not carry forward to daily reconciliation reports. |
store_id | COND | STR | 255 | Client assigned store ID. This field is required if participant is a Retail client. |
terminal_id | COND | STR | 255 | Client assigned terminal ID. This field is required if participant is a Retail client. |
clerk_id | COND | STR | 255 | Client assigned clerk ID. This field is required if participant is a Retail client. |
timestamp | RQD | INT | -> | Unix timestamp. |
version | RQD | INT | 2 | API version of the request. Current version is 11. |
{
"participant_id": 12345,
"account_type": "BP",
"amount": "1010.50",
"customer_account_token": "60be73ce-2c37-4c15-b509-1b270ee3f6df",
"source_of_funds": 4,
"recipient_phone": "1231231234",
"participant_unique_id1": "f8f68709-8e5d-4c19-8ca0-2eaffef4ec57",
"participant_unique_id2": "257b5bae-d52f-42e2-8f2c-0700d8d7a7a5",
"timestamp": 1587052152,
"version": 11
}
PARAMETER | RQMT | TYPE | DESCRIPTION |
---|---|---|---|
status | RQD | INT | Numeric code describing status of API request (e.g. 100 = Success). |
client_message | RQD | STR | Text description associated with status code. |
data | RQD | OBJ | Information about identifiers associated with the transaction |
estimated_posting_time | COND | STR | Provided on success. Estimated posting time of the payment: “Your payment will post within 5 minutes.” or “Your payment will post todays date.” or “Your payment will post next business day’s date.” |
estimated_posting_date | COND | STR | Provided on success. Estimated posting time of the payment in date format |
transaction_id | COND | INT | Always provided on success and in certain failure conditions. Unique transaction identifier generated with each successful request. |
request_timestamp | RQD | INT | Unix timestamp. |
customer_account_token | COND | STR | Echo of value from request. Provided on success. |
participant_unique_id1 | COND | STR | Always provided on success and in certain failure conditions. Echo of value provided on request. |
participant_unique_id2 | OPT | STR | Provided on success and in certain failure conditions if sent on original request. Echo of value provided on request. |
time | RQD | STR | Time in seconds to complete the request |
{
"status": 100,
"client_message": "Success",
"data": {
"estimated_posting_time": "Payment will post XX/XX/20XX",
"estimated_posting_date": "XX/XX/20XX",
"transaction_id": 2361525,
"request_timestamp": 1576099632,
"customer_account_token": "ca875cce-58c0-46a0-8f14-676190cc7df6",
"participant_unique_id1": "1f2739ed-3531-4af2-ae36-e6faf7936462",
"participant_unique_id2": "90759390-01c7-47e7-8a90-6faa89b18ff6"
},
"time": "1.1275"
}
{
"client_message": "Insufficient funds",
"data": {
"request_timestamp": 1576099632
},
"status": 604,
"time": "0.8644"
}
{
"status": 710,
"client_message": "Issuer Declined - Customer should contact card issuer",
"data": {
"request_timestamp": 1610648352
},
"time": "1.6609"
}
Purpose: Submit a request to generate a Card-Present payment.
PARAMETER | RQMT | TYPE | MAX_LEN | DESCRIPTION |
---|---|---|---|---|
participant_id | RQD | INT | 5 | Unique participant identifier assigned by Ingo |
account_type | RQD | STR | 2 | For card-based disbursements the value should be set to “CA”. For non-card Bill Pay disbursements the value should be set to “BP”. |
amount | RQD | DEC | 40 | Amount of the transaction |
customer_account_token | RQD | STR | 255 | Value representing the account number and customer data as provided in response from a previous Verify API call |
source_of_funds | RQD | INT | 1 | Funding source indicator: 1 – Cash, 2 – Check, 3 – Combo of Cash & Check, 4 – Corp Disb |
recipient_phone | OPT | STR | 10 | 10-digit recipient phone. |
participant_unique_id1 | RQD | STR | 255 | Participant assigned transaction ID for the process request. Value must be unique and may not contain NPI data. This value is used to determine whether a request has been previously received and processed successfully; if a request is duplicated, Ingo Payments will send an idempotent response and will NOT initiate a new push request. Value will appear on daily reconciliation reports. |
participant_unique_id2 | OPT | STR | 255 | Optional second participant assigned transaction ID for the request. This ID does not carry forward to daily reconciliation reports. |
store_id | COND | STR | 255 | Client assigned store ID. This field is required for select Retail client participants. |
terminal_id | COND | STR | 255 | Client assigned terminal ID. This field is required for select Retail client participants. |
clerk_id | COND | STR | 255 | Client assigned clerk ID. This field is required for select Retail client participants. |
retail_location | COND | OBJ | Client assigned retail location information. This object is required for select Retail client participants. | |
location_name | RQD | STR | 150 | Client assigned retail location name. |
location_id | RQD | STR | 150 | Client assigned retail location ID. |
location_address | RQD | STR | 150 | Client assigned retail location address. |
location_city | RQD | STR | 150 | Client assigned retail location city. |
location_state | RQD | STR | 2 | Client assigned retail location state. |
location_zip | RQD | STR | 10 | Client assigned retail location zip. |
track1 | COND | STR | 255 | URL encoded track 1 data from and including the beginning sentinel to and including the ending sentinel. Required for some transaction types. |
track2 | COND | STR | 255 | URL encoded track 2 data from and including the beginning sentinel to and including the ending sentinel. Required for some transaction types. |
timestamp | RQD | INT | -> | Unix timestamp. |
version | RQD | INT | 2 | API version of the request. Current version is 11. |
{
"participant_id": "12345",
"account_type": "CA",
"amount": "101.00",
"source_of_funds": "1",
"customer_account_token": "715b9903-7bcd-45ae-bc92-4092c8186d9f",
"track1": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"track2": "XXXXXXXXXXXXXXXXXXX",
"store_id": "11",
"terminal_id": "22",
"clerk_id": "33",
"retail_location": {
"location_name": "ABC",
"location_id": "1234",
"location_address": "456 Retail St.",
"location_city": "Atlanta",
"location_state": "GA",
"location_zip": "30333"
},
"participant_unique_id1": "fb746578-c4c3-498f-b398-1ff07b4fe2ff",
"participant_unique_id2": "77d6b010-eab4-44dc-9a27-6ffa4838c9f2",
"timestamp": "1579832334",
"version": "11"
}
{
"participant_id": 12345,
"account_type": "BP",
"amount": "1010.50",
"customer_account_token": "60be73ce-2c37-4c15-b509-1b270ee3f6df",
"source_of_funds": 4,
"recipient_phone": "1231231234",
"store_id": "11",
"terminal_id": "22",
"clerk_id": "33",
"retail_location": {
"location_name": "ABC",
"location_id": "1234",
"location_address": "456 Retail St.",
"location_city": "Atlanta",
"location_state": "GA",
"location_zip": "30333"
},
"participant_unique_id1": "f8f68709-8e5d-4c19-8ca0-2eaffef4ec57",
"participant_unique_id2": "257b5bae-d52f-42e2-8f2c-0700d8d7a7a5",
"timestamp": 1587052152,
"version": 11
}
PARAMETER | RQMT | TYPE | DESCRIPTION |
---|---|---|---|
status | RQD | INT | Numeric code describing status of API request (e.g. 100 = Success). |
client_message | RQD | STR | Text description associated with status code. |
data | RQD | OBJ | Information about identifiers associated with the transaction |
estimated_posting_time | COND | STR | Provided on success. Estimated posting time of the payment: “Your payment will post within 5 minutes.” or “Your payment will post todays date.” or “Your payment will post next business day’s date.” |
estimated_posting_date | COND | STR | Provided on success. Estimated posting time of the payment in date format |
transaction_id | COND | INT | Always provided on success and in certain failure conditions. Unique transaction identifier generated with each successful request. |
request_timestamp | RQD | INT | Unix timestamp. |
customer_account_token | COND | STR | Echo of value from request. Provided on success. |
participant_unique_id1 | COND | STR | Always provided on success and in certain failure conditions. Echo of value provided on request. |
participant_unique_id2 | OPT | STR | Provided on success and in certain failure conditions if sent on original request. Echo of value provided on request. |
pending_balance | COND | STR | Pending balance returned for designated retail clients |
time | RQD | STR | Time in seconds to complete the request |
{
"status": 100,
"client_message": "Success",
"data": {
"estimated_posting_time": "Payment will post XX/XX/20XX",
"estimated_posting_date": "XX/XX/20XX",
"transaction_id": 2758915,
"request_timestamp": 1579832334,
"customer_account_token": "715b9903-7bcd-45ae-bc92-4092c8186d9f",
"participant_unique_id1": "fb746578-c4c3-498f-b398-1ff07b4fe2ff",
"pending_balance": null
},
"time": "2.4628"
}
{
"client_message": "Insufficient funds",
"data": {
"request_timestamp": 1576099632
},
"status": 604,
"time": "0.8644"
}
{
"status": 710,
"client_message": "Issuer Declined - Customer should contact card issuer",
"data": {
"request_timestamp": 1579832334
},
"time": "1.6609"
}
Purpose: Submit a request to generate a Check payment.
PARAMETER | RQMT | TYPE | MAX_LEN | DESCRIPTION |
---|---|---|---|---|
participant_id | RQD | INT | 5 | Unique participant identifier assigned by Ingo. |
account_type | RQD | STR | 2 | Value will always be ‘CK’ for check disbursement transactions. |
amount | RQD | DEC | 40 | Amount of the transaction. |
customer_account_token | RQD | STR | 255 | Value representing the account number and customer data as provided in response from a previous Verify API call. |
source_of_funds | RQD | INT | 1 | Funding source indicator: 1 – Cash, 2 – Check, 3 – Combo of Cash & Check, 4 – Corp Disb |
recipient_phone | OPT | STR | 25 | Recipient phone. |
check_memo_data | OPT | STR | 30 | Additional information to be printed on the check itself. This information would be specific to this particular check issuance. Added to the right of the value of the beneficiary_account data on the printed check. Combined character total for beneficiary_account and check_memo_data cannot exceed 30 characters total. Additional characters will be truncated from the right of the check_memo_data value. |
remittance_memo_data | OPT | STR | 193 | Additional information to be printed on the remittance that is attached to the issued check. This information would be specific to this particular check issuance. 193 characters are available for this information in a freeform text field. Please keep in mind that the “Beneficiary” data from the token will already be presented on the remittance and any information in the remittance_memo_data field should be additive to that, not duplicative. |
participant_unique_id1 | RQD | STR | 255 | Participant assigned transaction ID for the process request. Value must be unique and may not contain NPI data. This value is used to determine whether a request has been previously received and processed successfully; if a request is duplicated, Ingo Payments will send an idempotent response and will NOT initiate a new push request. Value will appear on daily reconciliation reports. |
participant_unique_id2 | OPT | STR | 255 | Optional second participant assigned transaction ID for the request. This ID does not carry forward to daily reconciliation reports. |
timestamp | RQD | INT | -> | Unix timestamp. |
version | RQD | INT | 2 | API version of the request. Current version is 11. |
PARAMETER | RQMT | TYPE | DESCRIPTION |
---|---|---|---|
status | RQD | INT | Numeric code describing status of API request (e.g. 100 = Success). |
client_message | RQD | STR | Text description associated with status code. |
data | RQD | OBJ | Information about identifiers associated with the transaction. |
check_number | RQD | STR | Check number (10-digits) assigned to the newly created check. This number should be stored for tracking purposes. |
estimated_posting_time | RQD | STR | Estimated posting time of the payment: “Your payment will post within 5 minutes.” or “Your payment will post today’s date.” or “Your payment will post next business day’s date.” |
estimated_posting_date | RQD | STR | Estimated posting time of the payment in date format. |
transaction_id | RQD | INT | Unique transaction identifier generated with each successful request. |
request_timestamp | RQD | INT | Unix timestamp. |
customer_account_token | RQD | STR | Value representing the account number and customer data as provided in response from a previous Verify API call. |
participant_unique_id1 | RQD | STR | Participant assigned unique ID for the request. |
participant_unique_id2 | OPT | STR | Optional second participant assigned ID for the request. |
time | RQD | STR | Time in seconds to complete the request. |