メインコンテンツへスキップ
GET
/
api
/
v1
/
server-to-server-interface
/
transaction
/
status
/
{transactionId}
取引ステータスを取得
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": "取引は正常に完了しました。",
    "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
  }
}

​
重要なポイント

  • 取引IDは、特定の取引のステータスを問い合わせるために必要です。
  • APIは、取引の現在のステータスと関連するエラーコードやメッセージを含む詳細情報を返します。
  • このAPIは、取引ライフサイクルの追跡と管理に不可欠で、取引が正常に完了したことを確認するか、対応が必要な問題を特定します。

​
APIパラメータ

認証

​
Authorization
string
header
必須

認証のためのAPIキー。形式：'Basic YOUR_API_KEY_HERE'

​
x-api-key
string
header
必須

x-api-key専用のAPIキー。

パスパラメータ

​
transactionId
string
必須

事前承認（Pre-Auth）、キャプチャ（Capture）、払い戻し（Refund）、または無効（Void）取引の元の取引ID。

Maximum string length: 36

レスポンス

200 - application/json

取引ステータスが正常に取得されました

​
success
boolean

取引が成功した場合はtrue、失敗した場合はfalse。

例:

true

​
status_code
integer

取引のステータスコード。

例:

200

​
is_live
boolean

本番取引の場合はtrue、テスト取引の場合はfalse。

例:

false

​
transaction_type
string

取引タイプ（例：PRE_AUTH、CAPTURE）。

例:

"CAPTURE"

​
gateway_response
object

ゲートウェイからの応答を含むJSONオブジェクト。

​
merchant_details
object

加盟店の詳細を含むJSONオブジェクト。

​
payment_details
object

取引の支払い詳細を含むJSONオブジェクト。

​
transaction_details
object

取引の詳細を含むJSONオブジェクト。

​
risk_details
object

リスクの詳細を含むJSONオブジェクト。