GET
/
api
/
v1
/
server-to-server-interface
/
transaction
/
status
/
{transactionId}
curl --request GET \
  --url https://api-dev.paymentoptions.com/api/v1/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": "24"
    },
    "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": "billing@testemail.com",
        "address1": "1-2-3 Shinjuku",
        "phone_number": "N/A",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      },
      "shipping_address": {
        "country": "JP",
        "email": "shipping@testemail.com",
        "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 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.

​
merchant_details
object

A JSON object containing the details of the merchant.

​
payment_details
object

A JSON object containing the payment details of the transaction.

​
transaction_details
object

A JSON object containing details of the transaction.

​
risk_details
object

A JSON object containing details of risk.