Sign in
latestOpenAPI 3.0.12026-08-104068226.2 KB

a772504dcc9e

Card transactions simulation

(Beta, sandbox only) Simulate an unauthorized settlement

Creates a simulated unauthorized settlement. The API returns a transaction_key that corresponds 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>The account associated with the card specified in card_id must have an available balance.</li> </ul>

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

Path parameters

card_idstring required

ID of the card to use for the test transaction.

Request body

type'OCT' | 'PURCHASE' | 'PURCHASE_REVERSAL' | 'CASH_ATM_REVERSAL' | 'CASH_MANUAL_REVERSAL' | 'CASH_ATM' | 'CASH_MANUAL' | 'CREDIT_PRESENTMENT' | 'DEBIT_PRESENTMENT' | 'FORCE_POST_TRANSACTION' | 'DISPUTE_TRANSACTION' | 'FRAUD_TRANSACTION' required

The type of transaction.

pos_entry_mode'UNKNOWN' | 'MAG_STRIPE' | 'CHIP' | 'MANUAL_PAN_ENTRY' | 'CONTACTLESS' | 'CARD_NOT_PRESENT' 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 required

Terminal ID (should be 10 digits).

merchant_idstring integer required

Merchant ID (should be 15 digits).

merchant_namestring required

The merchant's name (max 25 characters).

merchant_citystring required

The merchant's city (max 13 characters).

merchant_countrystring ISO 3166 alpha-2 required

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

Example request

{
  "settlement": {
    "amount": "9",
    "transaction_amount": "8",
    "transaction_currency": "EUR"
  },
  "merchant_category_code": "5411",
  "acquirer_id": "123456",
  "approval_code": "053630",
  "terminal_id": "1234567890",
  "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"
}