Transaction Status API

Get Transaction Status

curl --request GET \
  --url https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/transaction/status/{transactionId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "status_code": 200,
  "is_live": false,
  "transaction_type": "CAPTURE",
  "gateway_response": {
    "version": "1",
    "type": "INFO",
    "message": "Payment Successful.",
    "code": "INFO0000"
  },
  "merchant_details": {
    "legal_name": "Tink15 Factory",
    "mid": "< Merchant ID >",
    "merchant_txn_ref": "qwe"
  },
  "payment_details": {
    "amount": 1000,
    "response_code": 0,
    "responseDescription": "The transaction was completed successfully.",
    "auth_code": "268004",
    "currency": "JPY",
    "payment_method": "ECMC-SSL",
    "scheme": "MASTERCARD",
    "card": {
      "name": "John Doe",
      "number": "5200000000001005",
      "exp_month": "12",
      "exp_year": "29"
    },
    "additional_data": {
      "payment_data_source": {
        "type": "card"
      }
    }
  },
  "transaction_details": {
    "id": "fc565b43-26f5-4906-92ae-d849edc3c3a1",
    "ref": 74811,
    "timestamp": "2024-11-25T08:24:36.000Z",
    "billing_details": {
      "billing_address": {
        "country": "JP",
        "email": "[email protected]",
        "address1": "1-2-3 Shinjuku",
        "phone_number": "N/A",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      },
      "shipping_address": {
        "country": "JP",
        "email": "[email protected]",
        "address1": "1-2-3 Shinjuku",
        "phone_number": "N/A",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      }
    }
  },
  "risk_details": {
    "risk_score": null
  }
}

GET

api

server-to-server-interface

transaction

status

{transactionId}

Get Transaction Status

curl --request GET \
  --url https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/transaction/status/{transactionId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "status_code": 200,
  "is_live": false,
  "transaction_type": "CAPTURE",
  "gateway_response": {
    "version": "1",
    "type": "INFO",
    "message": "Payment Successful.",
    "code": "INFO0000"
  },
  "merchant_details": {
    "legal_name": "Tink15 Factory",
    "mid": "< Merchant ID >",
    "merchant_txn_ref": "qwe"
  },
  "payment_details": {
    "amount": 1000,
    "response_code": 0,
    "responseDescription": "The transaction was completed successfully.",
    "auth_code": "268004",
    "currency": "JPY",
    "payment_method": "ECMC-SSL",
    "scheme": "MASTERCARD",
    "card": {
      "name": "John Doe",
      "number": "5200000000001005",
      "exp_month": "12",
      "exp_year": "29"
    },
    "additional_data": {
      "payment_data_source": {
        "type": "card"
      }
    }
  },
  "transaction_details": {
    "id": "fc565b43-26f5-4906-92ae-d849edc3c3a1",
    "ref": 74811,
    "timestamp": "2024-11-25T08:24:36.000Z",
    "billing_details": {
      "billing_address": {
        "country": "JP",
        "email": "[email protected]",
        "address1": "1-2-3 Shinjuku",
        "phone_number": "N/A",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      },
      "shipping_address": {
        "country": "JP",
        "email": "[email protected]",
        "address1": "1-2-3 Shinjuku",
        "phone_number": "N/A",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      }
    }
  },
  "risk_details": {
    "risk_score": null
  }
}

Key Points

The transactionId is required to query the status of the specific transaction.
The API will return detailed information about the transaction, including its current status and any relevant error codes or messages.
This API is essential for tracking and managing transaction lifecycles, ensuring that transactions are completed successfully or identifying any issues that require attention.

Api Parameters

Authorizations

Authorization

string

header

required

API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'

x-api-key

string

header

required

API Key specific to x-api-key.

Path Parameters

transactionId

string

required

The original transaction ID of the Pre-Auth, Capture, Refund, or Void transaction.

Maximum string length: 36

Response

200 - application/json

Transaction status retrieved successfully

success

boolean

True on successful transaction, false on failure.

Example:

true

status_code

integer

The status code of the transaction.

Example:

200

is_live

boolean

True if live transaction, false if test transaction.

Example:

false

transaction_type

string

The transaction type (e.g., PRE_AUTH, CAPTURE).

Example:

"CAPTURE"

gateway_response

object

A JSON object containing the response from the gateway.

Show child attributes

gateway_response.version

string

The version of the gateway.

Example:

"1"

gateway_response.type

string

Type of response, INFO for informative.

Example:

"INFO"

gateway_response.message

string

The message response from the gateway.

Example:

"Payment Successful."

gateway_response.code

string

Message code of the response.

Example:

"INFO0000"

merchant_details

object

A JSON object containing the details of the merchant.

Show child attributes

merchant_details.legal_name

string

The merchant’s legal name.

Example:

"Tink15 Factory"

merchant_details.mid

string

The merchant ID (DASMID).

Example:

"< Merchant ID >"

merchant_details.merchant_txn_ref

string

The merchant transaction reference.

Example:

"qwe"

payment_details

object

A JSON object containing the payment details of the transaction.

Show child attributes

payment_details.amount

number

The amount value of the transaction.

Example:

1000

payment_details.response_code

integer

The acquirer response code.

Example:

0

payment_details.responseDescription

string

The acquirer response description.

Example:

"The transaction was completed successfully."

payment_details.auth_code

string

The acquirer authorization code.

Example:

"268004"

payment_details.currency

string

The currency of the transaction.

Example:

"JPY"

payment_details.payment_method

string

The payment card type (e.g., Credit Card or Debit Card).

Example:

"ECMC-SSL"

payment_details.scheme

string

The card brand scheme (e.g., MASTERCARD).

Example:

"MASTERCARD"

payment_details.card

object

A JSON object containing details of the card.

Show child attributes

payment_details.card.name

string

The cardholder’s name on the card.

Example:

"John Doe"

payment_details.card.number

string

The card number (masked).

Example:

"5200000000001005"

payment_details.card.exp_month

string

The expiry month of the card.

Example:

"12"

payment_details.card.exp_year

string

The expiry year of the card.

Example:

"29"

payment_details.additional_data

object

A JSON object containing additional data.

Show child attributes

payment_details.additional_data.payment_data_source

object

A JSON object containing the payment data source.

Show child attributes

payment_details.additional_data.payment_data_source.type

string

The type of payment data source (e.g., Card, GooglePay, ApplePay).

Example:

"card"

transaction_details

object

A JSON object containing details of the transaction.

Show child attributes

transaction_details.id

string

The Transaction ID of the transaction.

Example:

"fc565b43-26f5-4906-92ae-d849edc3c3a1"

transaction_details.ref

integer

The authorization code of the transaction.

Example:

74811

transaction_details.timestamp

string

Date and time of the transaction.

Example:

"2024-11-25T08:24:36.000Z"

transaction_details.billing_details

object

A JSON object containing the billing details.

Show child attributes

transaction_details.billing_details.billing_address

object

A JSON object containing the billing address.

Show child attributes

transaction_details.billing_details.billing_address.country

string

The cardholder’s billing country code.

Example:

"JP"

transaction_details.billing_details.billing_address.email

string

The cardholder’s billing email address.

Example:

"[email protected]"

transaction_details.billing_details.billing_address.address1

string

The cardholder’s billing address line.

Example:

"1-2-3 Shinjuku"

transaction_details.billing_details.billing_address.phone_number

string

The cardholder’s billing phone number.

Example:

"N/A"

transaction_details.billing_details.billing_address.city

string

The cardholder’s billing city.

Example:

"Shinjuku-ku"

transaction_details.billing_details.billing_address.state

string

The cardholder’s billing state.

Example:

"Tokyo"

transaction_details.billing_details.billing_address.postal_code

string

The cardholder’s postal code.

Example:

"1600022"

transaction_details.billing_details.shipping_address

object

A JSON object containing the shipping address.

Show child attributes

transaction_details.billing_details.shipping_address.country

string

The cardholder’s shipping country code.

Example:

"JP"

transaction_details.billing_details.shipping_address.email

string

The cardholder’s shipping email address.

Example:

"[email protected]"

transaction_details.billing_details.shipping_address.address1

string

The cardholder’s shipping address line.

Example:

"1-2-3 Shinjuku"

transaction_details.billing_details.shipping_address.phone_number

string

The cardholder’s shipping phone number.

Example:

"N/A"

transaction_details.billing_details.shipping_address.city

string

The cardholder’s shipping city.

Example:

"Shinjuku-ku"

transaction_details.billing_details.shipping_address.state

string

The cardholder’s shipping state.

Example:

"Tokyo"

transaction_details.billing_details.shipping_address.postal_code

string

The cardholder’s shipping postal code.

Example:

"1600022"

risk_details

object

A JSON object containing details of risk.

Show child attributes

risk_details.risk_score

string

The risk score (if applicable).

Example:

null

Void Authorization API Generate Token API

⌘I

Getting Started

API Endpoints

Error and Response

Webhook

Key Points

Api Parameters

Authorizations

Path Parameters

Response

Getting Started

API Endpoints

Error and Response

Webhook

​Key Points

​Api Parameters

Authorizations

Path Parameters

Response

Key Points

Api Parameters