Create Simulated Incoming ACH Transaction
Use the Create Incoming Simulated ACH Transaction endpoint to simulate incoming ACH transactions in the <<glossary:CV>> environment. This endpoint creates a pending transaction, defined by the template name and template values passed in the request, and returns an ACH transaction ID. After a transaction is processed, details can be seen using Get Deposit History or Get All Transaction History.
For instructions on using this endpoint, see Setup for Incoming ACH Simulation.
FORM DATA
Input | Data type | Required | 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 | int | 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" |
templateName | string | X | Name of the template that determines which template values are required to simulate an incoming ACH transaction. | CreditsAndDebits or ManualReviewNameMatching | "CreditsAndDebits" |
templateValues | json object | X | JSON array containing the required metadata. See Incoming ACH Simulation Payload for the fields to include. | JSON string | [{"companyName": "Your Company","companyEntryDescription": "Subscribe","destinationAccountNumber": "987654321123","amount": "100","receiverName": "John Doe",”identificationNumber”:”789654"}] |
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.
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.
response_data object | null required
A structure for the response data. It can be empty but usually will contain information.
balance float required
The current account balance.
ach_transaction_id string required
Unique identifier for the ACH transaction.
Example Request
curl --location --request POST 'https://api-exact.cv.gpsrv.com/intserv/4.0/createSimulatedAchTransaction' \
--header 'accept: application/json' \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'response-content-type: json' \
--data-urlencode 'providerId=xxxx \
--data-urlencode 'apiLogin=xxxxx' \
--data-urlencode 'apiTransKey=xxxxx' \
--data-urlencode 'transactionId=5c373a9a-c195-4248-b2d5-a6bc78166578' \
--data-urlencode 'templateName=CreditsAndDebits' \
--data-urlencode 'templateValues={
"transactionType": "credit",
"companyName": "Name on Account",
"referenceCode": "22355678",
"identificationNumber": "#789654",
"effectiveEntryDate": "23530",
"destinationRoutingNumber": "123456789",
"originBankName": "BankOfEurope",
"originRoutingNumber": "987654321",
"destinationBankName": "BoFA",
"amount": 100,
"companyEntryDescription": "Pacific Gas",
"receiverName": "John Doe",
"standardEntryClassCode": "CCD",
"accountType": "checking",
"destinationAccountNumber": "12345678",
"paymentRelatedInformation" : "PO 1234",
"discretionaryData" :"S"
}'
Example Response
{
"status_code": 0,
"status": "Success",
"processing_time": 0.051,
"response_data": {
"ach_transaction_id": 14
},
"echo": {
"provider_transaction_id": "",
"provider_timestamp": null,
"transaction_id": "d06ee89c-984b-4628-8b54-cfd672b021b7"
},
"system_timestamp": "2023-05-30 13:52:08",
"rtoken": "0fca914b-2669-48cd-97e8-f247669a6034"
}
See Global Response Statuses for status codes that are common across endpoints.