GAgalileo-ft
Transaction Simulation

Create Simulated Incoming ACH Transaction

Changed on

Use the Create Simulated Incoming ACH Transaction endpoint to simulate an incoming ACH transaction 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.

For instructions on using this endpoint, see <a href="doc:simulating-ach-transactions" target="_blank">Simulating Incoming ACH Transactions</a>.

[block:callout]

{ "type": "warning", "title": "Warning", "body": "This endpoint does not support XML responses. If you pass response-content-type: xml, it will be ignored." } [/block]

[block:callout]

{ "type": "warning", "title": "Warning", "body": "Do not use this endpoint in <glossary:Production>." } [/block]

post/createSimulatedAchTransaction

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/createSimulatedAchTransaction
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by Galileo. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by Galileo. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

providerIdinteger required

Galileo-issued provider identifier. Pattern: Max 10 digits Example: 9999

transactionIdstring required

A unique provider-generated ID to identify this API call. A UUID is preferred. Pattern: 60 characters or less Example: "9845dk-39fdk3fj3-4483483478"

templateName'ManualReviewNameMatching' | 'CreditsAndDebits' required

Name of the template that determines which template values are required to simulate an incoming ACH transaction. Pattern: "CreditsAndDebits" or "ManualReviewNameMatching" Example: "CreditsAndDebits"

templateValuesstring required

JSON array containing the required metadata. See <a href="ref:api-reference-incoming-ach-simulation-payload-values" target="_blank">Incoming ACH Simulation Payload Values</a> for the fields to include. Pattern: JSON string Example: Refer to <a href="ref:api-reference-incoming-ach-simulation-payload-values#example-templatevalues-string" target="_blank">Example templateValues string</a>.

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "templateName": "CreditsAndDebits",
  "templateValues": "{\"transactionType\":\"credit\",\"companyName\":\"Your Company\",\"referenceCode\":\"92443671\",\"identificationNumber\":\"789654\",\"effectiveEntryDate\":\"330212\",\"destinationBankName\":\"Chase\",\"destinationRoutingNumber\":\"987654321123\",\"destinationAccountNumber\":\"987654321123\",\"originBankName\":\"Bank of America\",\"originRoutingNumber\":\"124001545\",\"amount\":\"100\",\"companyEntryDescription\":\"Subscribe\",\"receiverName\": \"John Doe\",\"standardEntryClassCode\":\"CCD\",\"accountType\":\"checking\"}"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A Galileo-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes