Transaction Simulation

Create Simulated Card Authorization

Changed on

Use the Create Simulated Card Authorization endpoint to simulate a card authorization in the <glossary:CV> environment. This endpoint creates but does not settle a card authorization for the account and returns a response code and its description with the auth_id.

  • Capture the auth_id to settle the transaction with <a href="ref:post_createsimulatedcardsettle" target="_blank">Create Simulated Card Settlement</a>.
  • For instructions on using this endpoint see <a href="doc:simulating-card-transactions" target="_blank">Simulating Card 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/createSimulatedCardAuth

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/createSimulatedCardAuth
  • 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

transactionIdinteger required

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

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

amountnumber required

The amount of the transaction in the currency at the point of sale. Pattern: Positive integer or decimal number Example: 100.00, 100, or 100.73

associationstring required

Specifies which card network to simulate: visa (Visa), mc_auth (Mastercard Credit).<!--`mc_debit` (Mastercard Debit), `star` (STAR), `coop` (Co-op), `visa_baseii` (Visa Base II), or `allpoint` (Allpoint).--> Pattern: string Example: "visa"

merchantNamestring required

Simulated merchant name. Pass 40 characters for the complete string or pass up to 22 characters and the simulator will add 18 characters of a simulated address. For settlements, this parameter is required when authId is not populated. Pattern: Max 40 alphanumeric characters Example: "Fred Jones Bagels"

acquirerIdstring

Simulated acquirer ID. If this value is not passed, the simulator inserts a random 6-digit number. Pattern: 6-digit number Example: 437723

terminalIdstring

Simulated terminal ID. If this value is not passed, the simulator inserts a random 8-digit number. Pattern: 8-digit number Example: 57395783

merchantIdstring

Simulated merchant ID. If this value is not passed, the simulator inserts a random 15-character alphanumeric string. Pattern: Max 15 alphanumeric characters Example: "asdf45sdf6sd3d0a"

currencyCodestring

The currency code for amount. Use ISO 4217 numeric currency codes. This parameter is required when using this endpoint outside the United States. Pattern: 3 digits Example: "840"

settleAmountnumber

The amount to be transferred from merchant to issuer in the settlement currency. Required when currencyCode differs from the account currency, or when specialFunctions: make_multicurrency. Pattern: Positive integer or decimal number Example: 100.00, 100, or 100.73

settleCurrencyCodestring

The currency code for settleAmount. Use ISO 4217 numeric currency codes. Required when currencyCode differs from the account currency, or when specialFunctions: make_multicurrency. Pattern: 3 digits Example: "124"

cardBillingAmountnumber

The amount that will be posted to the cardholder account in the currency of the account. Required when currencyCode differs from the account currency, or when specialFunctions: make_multicurrency. Pattern: Positive integer or decimal number Example: 100.00, 100, or 100.73

cardBillingCurrencyCodestring

The currency code for cardBillingAmount. Use ISO 4217 numeric currency codes. Required when currencyCode differs from the account currency, or when specialFunctions: make_multicurrency. Pattern: 3 digits Example: 484

mccstring

ISO 18245 merchant category code. Pattern: 4 digits Example: 3408

originalAuthIdstring

The auth_id of the previous authorization in a series, such as with a completion, reversal or incremental authorization. Required when transType is 3, 4, 5 or 6 (Visa) or 3 (Mastercard) or 4, 5, 6 (Star). Pattern: Numerals Example: 30582

specialFunctionsstring

Additional function to add to the simulated transaction. See the <a href="ref:api-reference-special-functions" target="_blank">Special Functions</a> enumeration for valid values. Pattern: Max 100 characters Example "add_cashback"

posEntryModestring

The first two characters of DE022. Specifies how the PAN was entered, such as magnetic stripe, EMV chip or contactless. See <a href="ref:api-reference-de022-codes" target="_blank">DE022 Codes</a> for possible values. Valid only when association: visa. Pattern: 2 characters Example: 01

requesterIdstring

An identifier for the entity that makes a tokenization request. Required when specialFunctions: make_tokenized. Pattern: Numerals Example: 3030303

walletIdstring

Identifier for the mobile wallet that contains the card that was used for the transaction. Required when association: mc_auth and specialFunctions: make_tokenized. Pattern: Numerals Example: 474747474

latitudeAndLongitudestring

The latitude and longitude of the point of sale. Valid only when association: visa and transType: 17. Default: 40.76078/-111.89105 (Salt Lake City, UT) Pattern: 99.99999/-99.99999 Example: "40.76078/-111.89105"

partialAmountnumber

Amount of a partial authorization. Valid only when association: mc_auth and specialFunctions: make_partial_reversal. Pattern: Integer or decimal amount Example: 100.00, 100, or 100.73

partialForeignAmountnumber

Amount of a partial authorization when the point of sale is a different country than the account. Valid only when association: mc_auth and specialFunctions: make_partial_reversal. Pattern: Integer or decimal amount Example: 100.00, 100, or 100.73

cashbackAmountnumber

Amount in localAmt that is provided in cash. Valid only when association: mc_auth and specialFunctions: make_cashback. Debit accounts only. Pattern: Integer or decimal amount Example: 100.00, 100, or 100.73

cashAdvanceAmountnumber

Amount in localAmt that is provided in cash. Valid only when association: mc_auth and specialFunctions: make_cashback. Credit accounts only. Pattern: Positive integer or decimal number Example: 100.00, 100, or 100.73

pinstring

To include the PIN that is already set for the card, leave this value blank and pass specialFunctions: add_pin (Visa) or specialFunctions: make_debit (Mastercard). Pass a value for this parameter to use that value in the request and also to change the PIN for the card. Pattern: 4 digits Example: 4395

transTypeinteger

The type of transaction to simulate. See the <a href="ref:api-reference-simulated-transaction-types" target="_blank">Simulated Transaction Types</a> enumeration for valid values. Pattern: 1 or 2 digits Example: 3

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