Transaction Authorization Simulator

TransactionAuthSimulator Simulate Transaction Authorizations to get response

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
auth_request_type
required
string (TransactionAuthSimRequestType)
Enum: "PURCHASE" "ECOMM" "PREAUTH" "PREAUTHCOMPLETION" "CASHWITHDRAWAL" "ATMBALANCEINQUIRY" "REFUND" "FULLREVERSAL" "PARTIALREVERSAL" "OCTIN" "CASHIN"
card_proxy
required
string non-empty

card proxy

avs_postal_code
string or null [ 5 .. 9 ] characters

postal code used to avs data

avs_address_line_1
string or null

address line 1 used for avs data

txn_amount
required
number <double>

Amount in the simulated auth message in local currency

txn_currency_code
string or null <= 3 characters

Currency of the transaction amount; can be defaulted to 840

currency_conv_rate
number <double>

Currency conversion rate; can be defaulted to 1.000000

settle_amount
number <double>

Transaction amount in settlement currency

settle_currency_code
string or null <= 3 characters

Currency in which settlement is done

cashback_amount
number <double>

Amount requested as cashback (applicable only for in purchase, pre-auth, and pre-auth completion requests)

billing_amount
number <double>

Billing amount in billing currency

billing_currency_code
string or null <= 3 characters

Currency in which billing is done

orig_txn_amount
number or null <double>

Original transaction amount; required for Partial Reversal and Full Reversal

partial_auth_ind
string (PartialAuthIndicatorType)
Enum: "SUPPORT" "NOSUPPORT"
mcc
string or null <= 4 characters

Merchant Category Code in the simulated auth message.

channel_name
string or null <= 16 characters

For MNGS and Discover; If not provided it will be defaulted to MNGS.

terminal_id
string or null <= 12 characters

ID of the terminal

acceptor_id
string or null <= 16 characters

Merchant acceptor ID in the simulated auth message. Defaults to pre-defined id if not provided but has to be provided (required) for Refund txn.

acceptor_country_code
string or null <= 3 characters

Merchant’s country. Defaults to 840 if not provided.

acceptor_name_loc
string or null <= 40 characters

Merchant name and location.

retrieval_reference
string or null <= 24 characters

Unique number for identification; required for Preauth Completion, Partial Reversal, and Full Reversal

stan
string or null <= 12 characters

System trace audit number. Will be built if not provided

network_id
string or null <= 10 characters

network id

country_code
string or null <= 3 characters

Country Code

object (fleet_data)

Fleet Card Auth Prompts Info

Responses
201

Transaction auth sim response

400

Bad request

401

Unauthorized

404

Not Found

500

Server Error

post/api/{version}/TransactionAuthSimulator
Request samples
application/json
{
  • "auth_request_type": "PURCHASE",
  • "card_proxy": "string",
  • "avs_postal_code": "string",
  • "avs_address_line_1": "string",
  • "txn_amount": 0,
  • "txn_currency_code": "str",
  • "currency_conv_rate": 0,
  • "settle_amount": 0,
  • "settle_currency_code": "str",
  • "cashback_amount": 0,
  • "billing_amount": 0,
  • "billing_currency_code": "str",
  • "orig_txn_amount": 0,
  • "partial_auth_ind": "SUPPORT",
  • "mcc": "stri",
  • "channel_name": "string",
  • "terminal_id": "string",
  • "acceptor_id": "string",
  • "acceptor_country_code": "str",
  • "acceptor_name_loc": "string",
  • "retrieval_reference": "string",
  • "stan": "string",
  • "network_id": "string",
  • "country_code": "str",
  • "fleet_data": {
    • "driver_id": "string",
    • "vehicle_id": "string"
    }
}
Response samples
application/json
{
  • "card_proxy": "string",
  • "card_auth_txn_guid": "f0cb5c93-2e51-4afc-ac13-68fa4ac87119",
  • "request_code": "string",
  • "response_code": "string",
  • "reason_code": "string",
  • "txn_amount": 0,
  • "settle_amount": 0,
  • "billing_amount": 0,
  • "billing_fee": 0,
  • "billing_conversion_rate": 0,
  • "stan": "string",
  • "settlement_date": "string",
  • "mcc": "string",
  • "channel_name": "string",
  • "txn_fee_amount": 0,
  • "settle_fee_amount": 0,
  • "retrieval_reference": "string",
  • "authorization_id_code": "string",
  • "terminal_id": "string",
  • "acceptor_id": "string",
  • "acceptor_name_loc": "string",
  • "txn_currency_code": "string",
  • "settle_currency_code": "string",
  • "billing_currency_code": "string",
  • "avs_indicator": "string",
  • "avs_result": "string",
  • "avs_data": "string",
  • "partial_auth_ind": "string",
  • "network_id": "string",
  • "original_amount": 0,
  • "mask_card_pan": "string",
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "issuance_type": "string",
  • "card_status": "string",
  • "expiration_date": "2019-08-24T14:15:22Z",
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "account_currency": "string",
  • "available_balance": 0,
  • "ledger_balance": 0,
  • "suspense_balance": 0,
  • "account_status": "string",
  • "request_description": "string",
  • "country_code_alpha3": "string",
  • "currency_code_alpha3": "string",
  • "fees": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "fee_request_code": "string",
      • "fee_request_description": "string",
      • "fee_amount": 0,
      • "reverse_fee_request_code": "string",
      • "reverse_fee_request_description": "string"
      }
    ],
  • "total_fee_amount": 0,
  • "fleet_data": {
    • "driver_id": "string",
    • "vehicle_id": "string"
    }
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.