Sign in
latestOpenAPI 3.0.12026-08-104068226.2 KB

a772504dcc9e

Card transactions simulation

(Beta, sandbox only) Simulate an authorization

Creates a simulated card authorization for the purpose of testing approval & denial flows.<br> Calling this endpoint will trigger a webhook notification on CARD_AUTHORIZATION or CARD_AUTHORIZATION_DECLINE_V2 (depending on whether the test transaction should be approved or declined).<br> The API returns a transaction_key corresponding with the created transaction. You can query info about the transaction using GET Index account bookings or GET Index reservations.<br> Please note the following: <ul> <li>This is a beta endpoint.</li> <li>The account associated with the card specified in card_id must have an available balance.</li> </ul>

post/v1/cards/{card_id}/simulator/transactions/authorization

Path parameters

card_idstring required

ID of the card to use for the test transaction.

Request body

type'PURCHASE' | 'CASH_ATM' | 'OCT' required

The type of transaction.

transaction_currencystring required

Currency code of the transaction.

pos_entry_mode'CHIP' | 'CONTACTLESS' | 'MAG_STRIPE' | 'MANUAL_PAN_ENTRY' | 'UNKNOWN' required

The POS entry mode used to complete the transaction.

merchant_category_codestring integer required

The merchant category code (should be 4 digits).

acquirer_idstring integer required

The acquirer ID (up to 6 digits).

approval_codestring integer required

The approval code (should be 6 digits).

terminal_idstring integer

Terminal ID (should be 8 digits).

merchant_idstring integer required

Merchant ID (should be 15 digits).

merchant_namestring required

The merchant's name (up to 24 characters).

merchant_citystring required

The merchant's city (up to 13 characters).

merchant_countrystring ISO 3166 alpha-2 required

The merchant's country (ISO 3166 two-character code).

Example request

{
  "authorization": {
    "amount": "000000004023",
    "transaction_amount": "000000004023"
  },
  "transaction_currency": "USD",
  "merchant_category_code": "5411",
  "acquirer_id": "123456",
  "approval_code": "053630",
  "terminal_id": "12345678",
  "merchant_id": "123456789101112",
  "merchant_name": "Solarisbank AG",
  "merchant_city": "Berlin",
  "merchant_country": "DE"
}

Response

The operation was successful.

transaction_keystring required

ID of the created authorization.

Example response

{
  "transaction_key": "100000000142424"
}