APIエンドポイント
- サーバー間通信
- トークン化
- サブスクリプション
- ウォレット
- ホスト決済ページ
エラーとレスポンス
ウェブフック
取引ステータスAPI
取引ステータスAPIは、特定の取引の現在のステータスを取得するために使用され、事前認証、キャプチャ、返金、または無効化された取引を含みます。
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": "取引は正常に完了しました。",
"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
}
}
重要なポイント
-
取引IDは、特定の取引のステータスを問い合わせるために必要です。
-
APIは、取引の現在のステータスと関連するエラーコードやメッセージを含む詳細情報を返します。
-
このAPIは、取引ライフサイクルの追跡と管理に不可欠で、取引が正常に完了したことを確認するか、対応が必要な問題を特定します。
APIパラメータ
Authorizations
認証のためのAPIキー。形式:'Basic YOUR_API_KEY_HERE'
x-api-key専用のAPIキー。
Path Parameters
事前承認(Pre-Auth)、キャプチャ(Capture)、払い戻し(Refund)、または無効(Void)取引の元の取引ID。
36
Response
取引が成功した場合はtrue、失敗した場合はfalse。
true
取引のステータスコード。
200
本番取引の場合はtrue、テスト取引の場合はfalse。
false
取引タイプ(例:PRE_AUTH、CAPTURE)。
"CAPTURE"
取引の支払い詳細を含むJSONオブジェクト。
取引の金額。
1000
アクワイアラー応答コード。
0
アクワイアラーの応答説明。
"取引は正常に完了しました。"
アクワイアラーの認証コード。
"268004"
取引の通貨。
"JPY"
支払いカードの種類(例:クレジットカードまたはデビットカード)。
"ECMC-SSL"
カードブランドのスキーム(例:MASTERCARD)。
"MASTERCARD"
取引の詳細を含むJSONオブジェクト。
取引のトランザクションID。
"fc565b43-26f5-4906-92ae-d849edc3c3a1"
取引の認証コード。
74811
取引の日付と時刻。
"2024-11-25T08:24:36.000Z"
請求情報を含むJSONオブジェクト。
請求先住所を含むJSONオブジェクト。
カード所有者の請求先国コード。
"JP"
カード所有者の請求先メールアドレス。
"billing@testemail.com"
カード所有者の請求先住所の詳細。
"1-2-3 Shinjuku"
カード所有者の請求先電話番号。
"N/A"
カード所有者の請求先都市。
"Shinjuku-ku"
カード所有者の請求先都道府県。
"Tokyo"
カード所有者の郵便番号。
"1600022"
配送先住所を含むJSONオブジェクト。
カード所有者の配送先国コード。
"JP"
カード所有者の配送先メールアドレス。
"shipping@testemail.com"
カード所有者の配送先住所の詳細。
"1-2-3 Shinjuku"
カード所有者の配送先電話番号。
"N/A"
カード所有者の配送先都市。
"Shinjuku-ku"
カード所有者の配送先都道府県。
"Tokyo"
カード所有者の配送先郵便番号。
"1600022"
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": "取引は正常に完了しました。",
"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
}
}