Process (Credit/Push to 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 ‘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
email	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.

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

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

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

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.

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

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.

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

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.

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

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.

¶ Overview

¶ Process Request

¶ Process Response

¶ Process Request

¶ Process Response

¶ Process Request

¶ Process Response

¶ Process Request

¶ Process Response

¶ Process Request

¶ Process Response

¶ Process Request

¶ Process Response