Get Simulated Incoming ACH Transaction
Returns a pending transaction matching the provided ID. If the transaction has been processed already, use the Get Deposit History or Get All Transaction History endpoints.
For instructions on using this endpoint, see Setup for Incoming ACH Simulation.
Form Data
Parameter | Req | Data type | Description | Pattern | Example |
---|---|---|---|---|---|
apiLogin | string | X | Provider's web service username, as provided by Galileo for the requesting IP address. | Max 50 characters | "AbC123-9999" |
apiTransKey | string | X | Web service password, as provided by Galileo for the requesting IP address. | Max 15 characters | "4sb62fh6w4h7w34g" |
providerId | int32 | X | Galileo-issued unique provider identifier. | Max 10 digits | “9999” |
transactionId | string | X | A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls. | 60 characters or less | "9845dk-39fdk3fj3-4483483478" |
achTransactionId | int32 | X | The ach_transaction_id, as returned by the Create Simulated Incoming ACH Transaction endpoint is used. | positive integer | "354656" |
RESPONSE
Output will be in similar format as mentioned in API Response above except response data:
status_code integer | null required
The response status code. (may return a string for some statuses).
status string | null required
The condition of a process or response.
processing_time number | null required
The time elapsed in processing the transaction.
response_data object | null required
A structure for the response data. Contains information when successful, empty when failed.
template_name string | required
The name of the template used to generate the NACHA file.
template_values | object required
Contains key values that fill up the template format.
accountType string | required
Allowed values: “checking” or “savings”.
amount float | required
Description for the ACH transfer.
companyEntryDescription string | required
A description of the company entry.
companyName string | required
Company originating the transaction.
destinationAccountNumber string | required
Receiver’s account number.
destinationBankName string | required
Receiver’s bank name.
destinationRoutingNumber string | required
Receiver’s routing number.
discretionaryData string
Code applied by ODFI to enable specialized handling.
effectiveEntryDate string
Effective date for the transaction, equal or greater than today’s date.
identificationNumber string | required
Internal identification (alphanumeric).
originBankName string | required
Sender’s bank name.
originRoutingNumber string | required
Sender’s bank name.
paymentRelatedInformation string |
Text for describing the related payment.
receiverName string | required
The name of the receiver, usually the name on the bank account or
Receiving company name.
referenceCode string | required
Reference code, can be any string.
standardEntryClassCode string | required
Identifies the payment type found within an ACH batch using a
3-character code.
transactionType string | required
Allowed values: “credit” or “debit”.
echo object | null required
A structure that contains transaction ID information.
transaction_id string | null required
An ID that represents an API transaction.
provider_timestamp string | null required
Store a related timestamp for reporting and troubleshooting purposes.
provider_transaction_id string | null required
Secondary transaction identifier (generated by a provider).
system_timestamp string | null required
A system generated timestamp.
rtoken string | null required
A Galileo-generated ID used for tracking.
errors | array of strings
A list of errors generated while the request was processed.
Example request
curl --location --request POST 'https://api-exact.cv.gpsrv.com/intserv/4.0/getSimulatedAchTransaction' \
--header 'accept: application/json' \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'response-content-type: json' \
--data-urlencode 'providerId=xxxxx' \
--data-urlencode 'apiLogin=xxxxx' \
--data-urlencode 'apiTransKey=xxxxx' \
--data-urlencode 'transactionId=c6a7a9f7-aff2-401e-a68c-b75667cadbbb' \
--data-urlencode 'achTransactionId=302'
Example response
{
"status_code": 0,
"status": "Success",
"processing_time": 0.379,
"response_data": {
"template_name": "CreditsAndDebits",
"template_values": {
"accountType": "checking",
"amount": 1,
"companyEntryDescription": "Pacific Gas",
"companyName": "Name on Account",
"destinationAccountNumber": "123456789",
"destinationBankName": "BoFa",
"destinationRoutingNumber": "12345678",
"discretionaryData": "S",
"effectiveEntryDate": "230530",
"identificationNumber": "#789654",
"originBankName": "CHASE",
"originRoutingNumber": "987654321",
"paymentRelatedInformation": "some info",
"receiverName": "John Doe",
"referenceCode": "22355678",
"standardEntryClassCode": "PPD",
"transactionType": "credit"
}
},
"echo": {
"provider_transaction_id": "",
"provider_timestamp": null,
"transaction_id": "c6a7a9f7-aff2-401e-a68c-b75667cadbbb"
},
"system_timestamp": "2023-05-30 10:56:53",
"rtoken": "82f354f8-0520-4b6c-a952-07228500c1c3"
}
See Global Response Statuses for status codes that are common across endpoints.