Skip to content
/
Card transactions simulat...

Card creation & servicing (1.0)

Download OpenAPI description
cards.json
cards.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/cards/

Cards servicing

Operations

Encrypted PIN Change

Operations

Card spending controls

Operations

Card transactions

Operations

Card transactions simulation

Operations

(Sandbox only) Create test fraud case

Request

This endpoint simulates a fraudulent transaction for the card specified in the request URL. The fraudulent transaction process will begin as a result.
This endpoint is only available on Sandbox.

Path
card_idstringrequired
No request payload

Responses

Successful result of the operation

Body
Response
No content

(Sandbox only) Create test 3DS transaction

Request

This endpoint simulates a test 3DS transaction for the card_id specified in the request URL.
Calling this endpoint will begin the 3DS transaction process. The API will return a JSON schema containing the HTML for the 3DS challenge screen.
This endpoint is only available on Sandbox.

Path
card_idstringrequired
Bodyapplication/json
merchant_namestringrequired

The name of the merchant.

purchase_currencystringrequired

The currency used for the purchase.

purchase_amountintegerrequired

The purchase amount (in Euro cents).

application/json
{
  "merchant_name": "Merchant Name",
  "purchase_currency": "EUR",
  "purchase_amount": 1000
}

Responses

Successful result of the operation

Bodyapplication/json
htmlstring

The HTML for the 3DS challenge screen.

Example: "<html>...</html>"
Response
application/json
{
  "html": "<html>...</html>"
}

(Beta, sandbox only) Simulate an authorization

Request

Creates a simulated card authorization for the purpose of testing approval & denial flows.
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).
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.
Please note the following:

  • This is a beta endpoint.
  • The account associated with the card specified in card_id must have an available balance.

Path
card_idstringrequired

ID of the card to use for the test transaction.

Bodyapplication/jsonrequired
typestringrequired

The type of transaction.

Enum"PURCHASE""CASH_ATM""OCT"
authorizationobjectrequired

The amount of the card authorization.

authorization.​amountstring(integer)required
Example: "000000004023"
authorization.​transaction_amountstring(integer)required
Example: "000000004023"
transaction_currencystringrequired

Currency code of the transaction.

Example: "USD"
pos_entry_modestringrequired

The POS entry mode used to complete the transaction.

Enum"CHIP""CONTACTLESS""MAG_STRIPE""MANUAL_PAN_ENTRY""UNKNOWN"
merchant_category_codestring(integer)required

The merchant category code (should be 4 digits).

Example: "5411"
acquirer_idstring(integer)required

The acquirer ID (up to 6 digits).

Example: "123456"
merchant_idstring(integer)required

Merchant ID (should be 15 digits).

Example: "123456789101112"
approval_codestring(integer)required

The approval code (should be 6 digits).

Example: "053630"
merchant_namestringrequired

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

Example: "Solarisbank AG"
merchant_citystringrequired

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

Example: "Berlin"
merchant_countrystring(ISO 3166 alpha-2)required

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

Example: "DE"
terminal_idstring(integer)

Terminal ID (should be 8 digits).

Example: "12345678"
application/json
{
  "type": "PURCHASE",
  "authorization": {
    "amount": "000000004023",
    "transaction_amount": "000000004023"
  },
  "transaction_currency": "USD",
  "pos_entry_mode": "CHIP",
  "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"
}

Responses

The operation was successful.

Bodyapplication/json
transaction_keystringrequired

ID of the created authorization.

Example: "100000000142424"
Response
application/json
{
  "transaction_key": "100000000142424"
}

(Beta, sandbox only) Simulate an unauthorized settlement

Request

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.
Please note the following:

  • The account associated with the card specified in card_id must have an available balance.

Path
card_idstringrequired

ID of the card to use for the test transaction.

Bodyapplication/jsonrequired
settlementobjectrequired

The type of settlement.

settlement.​transaction_amountstring(integer)required

The original transaction amount.

Example: "8"
settlement.​amountstring(integer)required

The transaction amount + applicable fees.

Example: "9"
settlement.​transaction_currencystringrequired

The currency used in the transaction.

Example: "EUR"
typestringrequired

The type of transaction.

Enum"OCT""PURCHASE""PURCHASE_REVERSAL""CASH_ATM_REVERSAL""CASH_MANUAL_REVERSAL""CASH_ATM""CASH_MANUAL""CREDIT_PRESENTMENT""DEBIT_PRESENTMENT""FORCE_POST_TRANSACTION"
pos_entry_modestringrequired

The POS entry mode used to complete the transaction.

Enum"UNKNOWN""MAG_STRIPE""CHIP""MANUAL_PAN_ENTRY""CONTACTLESS""CARD_NOT_PRESENT"
merchant_category_codestring(integer)required

The merchant category code (should be 4 digits).

Example: "5411"
acquirer_idstring(integer)required

The acquirer ID (up to 6 digits).

Example: "123456"
approval_codestring(integer)required

The approval code (should be 6 digits).

Example: "053630"
terminal_idstring(integer)required

Terminal ID (should be 10 digits).

Example: "1234567890"
merchant_idstring(integer)required

Merchant ID (should be 15 digits).

Example: "123456789101112"
merchant_namestringrequired

The merchant's name (max 25 characters).

Example: "Solarisbank AG"
merchant_citystringrequired

The merchant's city (max 13 characters).

Example: "Berlin"
merchant_countrystring(ISO 3166 alpha-2)required

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

Example: "DE"
application/json
{
  "settlement": {
    "amount": "9",
    "transaction_amount": "8",
    "transaction_currency": "EUR"
  },
  "type": "OCT",
  "pos_entry_mode": "UNKNOWN",
  "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"
}

Responses

The operation was successful.

Bodyapplication/json
transaction_keystringrequired

ID of the created authorization.

Example: "100000000142424"
Response
application/json
{
  "transaction_key": "100000000142424"
}

(Beta, sandbox only) Simulate the settlement of an authorization

Request

Executes a test card authorization settlement for the given card_id and transaction_key. 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.
Please note the following:

  • This is a beta endpoint.
  • The account associated with the card specified in card_id must have an available balance.

Path
card_idstringrequired

ID of the card to use for the test transaction.

transaction_keystringrequired

transaction_key of the card transaction.

Bodyapplication/jsonrequired
settlementobjectrequired

The type of settlement.

settlement.​transaction_amountstring(integer)required

The original transaction amount.

Example: "8"
settlement.​amountstring(integer)required

The transaction amount + applicable fees.

Example: "9"
settlement.​transaction_currencystringrequired

The currency used in the transaction.

Example: "EUR"
application/json
{
  "settlement": {
    "amount": "9",
    "transaction_amount": "8",
    "transaction_currency": "EUR"
  }
}

Responses

The operation was successful.

Bodyapplication/json
transaction_keystringrequired

ID of the created authorization.

Example: "100000000142424"
Response
application/json
{
  "transaction_key": "100000000142424"
}

(Beta, sandbox only) Simulate an expired card authorization

Request

Marks the card authorization as expired for the given transaction_key. The API returns the 202 (Accepted) response code and an empty response body.
Note: This is a beta endpoint.

Path
transaction_keystringrequired

transaction_key of the card transaction to mark as expired.

No request payload

Responses

The operation was successful.

Response
No content

Card Delivery Tracking API

Operations