メインコンテンツへスキップ
POST
/
api
/
v1
/
server-to-server-interface
/
authorization
支払いを承認する
curl --request POST \
  --url https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/authorization \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": "1000",
  "currency": "JPY",
  "card": {
    "cvc": "100",
    "expiry_month": "12",
    "expiry_year": "29",
    "name": "John Doe",
    "number": "5200000000001005"
  },
  "merchant_id": "< Merchant ID >",
  "billing_address": {
    "country": "JP",
    "email": "billing@testemail.com",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "merchant_txn_ref": "qwe",
  "customer_ip": "127.0.0.1",
  "return_url": {
    "webhook_url": "< Webhook url >",
    "success_url": "http://www.successurl.com/",
    "decline_url": "http://www.declineurl.com/"
  },
  "shipping_address": {
    "country": "JP",
    "email": "shipping@testemail.com",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "browser_info": {
    "acceptHeader": "text/html",
    "screenColorDepth": "48",
    "javaEnabled": false,
    "language": "en",
    "screenHeight": "1200",
    "screenWidth": "1600",
    "challengeWindow": "4",
    "userAgent": "Mozilla/4.0 (MSIE 6.0; Windows NT 5.0)"
  },
  "time_zone": "Asia/Kuala_Lumpur"
}
'
{
  "success": true,
  "status_code": 201,
  "is_live": false,
  "transaction_type": "PRE_AUTH",
  "gateway_response": {
    "version": "1",
    "type": "INFO",
    "message": "Payment Successful.",
    "code": "INFO0000"
  },
  "merchant_details": {
    "legal_name": "Tink15 Factory",
    "mid": "< Merchant ID >",
    "merchant_txn_ref": "qwe",
    "billing_details": {
      "billing_address": {
        "country": "JP",
        "email": "billing@testemail.com",
        "phone_number": "8112345678",
        "address1": "1-2-3 Shinjuku",
        "city": "Shinjuku-ku",
        "state": "Tokyo",
        "postal_code": "1600022"
      }
    },
    "device_details": {
      "visited_ip": "127.0.0.1",
      "merchant_ip": "127.0.0.1",
      "customer_ip": "127.0.0.1"
    }
  },
  "payment_details": {
    "amount": 1000,
    "response_code": 0,
    "auth_code": "917290",
    "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": "ab8444e7-fec0-40dd-994d-0ad813785f74",
    "ref": 74797,
    "timestamp": "2024-11-25T07:22:48.000Z",
    "merchant_txn_ref": "qwe",
    "stored_payment_method_id": null
  },
  "risk-details": {
    "risk_score": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.paymentoptions.com/llms.txt

Use this file to discover all available pages before exploring further.

注意: 認証API (v1) は非推奨予定です。将来の統合にはバージョン2をご使用ください。

​
重要なポイント

  • 認証APIは、顧客の支払い方法で指定された金額を確保しますが、キャプチャが行われるまで資金は転送されません。
  • キャプチャ: 顧客のアカウントから認証された資金を転送して取引を完了します。
  • 無効: 認証をキャンセルし、保留された資金を顧客に返金します。
  • このAPIの使用例には、最終的な金額が変動する可能性のある状況（ホテルの予約、車のレンタル、事前注文など）が含まれます。

​
フローダイアグラム

Flow diagram image

​
APIパラメータ

承認

​
Authorization
string
header
必須

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

​
x-api-key
string
header
必須

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

ボディ

application/json

支払い取引を承認するためのリクエストペイロード。

​
amount
string
必須

取引の金額。

例:

"1000"

​
currency
string
必須

商品の処理通貨の略称（例：JPY）。

Maximum string length: 3
例:

"JPY"

​
card
object
必須

カードの詳細を含むJSONオブジェクト。

​
merchant_id
string
必須

加盟店ID（DASMID）。

Maximum string length: 128
例:

"< Merchant ID >"

​
billing_address
object
必須

カード所有者の請求先住所を含むJSONオブジェクト。

​
merchant_txn_ref
string

加盟店の取引参照ID。

Maximum string length: 45
例:

"qwe"

​
customer_ip
string

カード所有者のIPアドレス。

Maximum string length: 45
例:

"127.0.0.1"

​
return_url
object

返却URLを含むJSONオブジェクト。（このフィールドは3DS取引で必須です。）

​
shipping_address
object

カード所有者の配送先住所を含むJSONオブジェクト（オプション）。

​
browser_info
object

カード所有者が使用するブラウザの詳細を含むJSONオブジェクト（オプション）。

​
time_zone
string

取引の国別タイムゾーン。

Maximum string length: 128
例:

"Asia/Kuala_Lumpur"

レスポンス

201 - application/json

支払いが正常に承認されました

​
success
boolean

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

例:

true

​
status_code
integer

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

例:

201

​
is_live
boolean

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

例:

false

​
transaction_type
string

取引タイプ（例：PRE_AUTH）。

例:

"PRE_AUTH"

​
gateway_response
object

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

​
merchant_details
object

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

​
payment_details
object

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

​
transaction_details
object

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

​
risk-details
object

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