v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Simulator

Simulate Authorization

Simulate an authorization type transaction by including the card_id and other authorization details in your request. Only cards with BINs below are supported for simulation.

40963608

post/v1/simulation/issuing/authorization

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Request body

card_idstring required

Unique identifier for the card.

transaction_amountnumber required

The transaction amount to simulate.

transaction_currencystring required

Currency of the transaction.

merchant_namestring required

Name of the merchant

merchant_category_codestring required

The merchant category code for the merchant's business. Can only be 5734.

Example request

{
  "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
  "transaction_amount": 10,
  "transaction_currency": "USD",
  "merchant_name": "Orchard Central",
  "merchant_category_code": "5734"
}

Response

Authorization simulated successfully.

card_idstring required

Unique identifier for the card.

card_numberstring required

Masked card number

cardholder_idstring uuid required

The cardholder's unique identifier.

transaction_idstring uuid required

Unique Identifier for transaction

transaction_type'AUTHORIZATION' | 'REFUND' | 'REVERSAL' required

The type of transaction being simulated.

card_available_balancenumber required

The card available balance.

authorization_codestring required

Authorization Code

billing_amountnumber required

Billing amount

billing_currencystring required

Billing Currency

transaction_amountnumber required

Transaction amount

transaction_currencystring required

Transaction currency

transaction_timestring required

Transaction occurrence time

posted_timestring

Transaction posted time

failure_reasonstring required

Reason for transaction failure.

transaction_status'APPROVED' | 'DECLINED' required

The high-level status indicating the stage of the transaction lifecycle.

Example response

{
  "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
  "card_number": "************5668",
  "cardholder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
  "transaction_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
  "transaction_type": "AUTHORIZATION",
  "card_available_balance": 2506.26,
  "authorization_code": "856268",
  "billing_amount": 70.25,
  "billing_currency": "SGD",
  "transaction_amount": 100.25,
  "transaction_currency": "USD",
  "transaction_time": "2024-03-21T17:17:32+08:00",
  "posted_time": "2024-03-21T17:17:32+08:00",
  "merchant_data": {
    "category_code": "6011",
    "city": "CITY NAME",
    "country": "CN",
    "name": "ACQUIRER NAME"
  },
  "failure_reason": "1107 - Invalid CVV2",
  "transaction_status": "APPROVED"
}