トークンAPIの生成

重要なポイント

カードをトークン化することで、カード詳細を再入力することなく繰り返し取引を行うことができ、セキュリティとユーザー体験の向上が図れます。
生成されたトークンは、購入と認証の両方の取引で使用でき、さまざまな支払いタイプに対応する柔軟性を提供します。
重要なパラメータには通常、カード番号、有効期限、CVV、顧客情報が含まれます。

フローダイアグラム

ノート

store_payment_method: 将来の使用のためにカードトークンを保存するには、ペイロードで true に設定する必要があります。

リクエスト例

{
  "payment_method": {
    "type": "scheme",
    "store_payment_method": true
  }

store_payment_method を true に設定することで、カード詳細を再入力することなく、カードトークンが今後の取引のために保存されます。

レスポンス例

{
  "transaction_details": {
    "id": "<transaction_id>",
    "ref": <ref>,
    "timestamp": "yyyy-mm-ddThh:mm:ss.000Z",
    "merchant_txn_ref": "<string>",
    "stored_payment_method_id": "094db781-fabc-4c6d-8fcd-18bee06a527a"
  }
}

stored_payment_method_id は、カード詳細を再入力することなく、今後の取引でカードトークンAPIを使用するために利用できます。

APIパラメータ

Authorizations

Authorization

string

header

required

認証のためのAPIキー。フォーマット: 'Basic YOUR_API_KEY_HERE'

x-api-key

string

header

required

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

Body

application/json

決済取引を処理するためのリクエストペイロード。

amount

string

required

取引の金額。

Example:

"1000"

currency

string

required

処理通貨の略語（例: JPY）。

Maximum string length: 3

Example:

"JPY"

card

object

required

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

表示子属性

card.cvc

string

カードのセキュリティコード（通常3桁、AMEXは4桁）。

Maximum string length: 4

Example:

"100"

card.expiry_month

string

カードの有効期限（月）（例: 12 = 12月）。

Maximum string length: 2

Example:

"12"

card.expiry_year

string

カードの有効期限の年（例：29 または 2029 年）。

Maximum string length: 4

Example:

"29"

card.name

string

カード名義人の名前。

Maximum string length: 255

Example:

"John Doe"

card.number

string

カード番号。

Maximum string length: 16

Example:

"4000000000001091"

payment_method

object

required

決済方法を含むJSONオブジェクト。

表示子属性

payment_method.type

string

決済方法の種類（例: 'scheme'）。

Maximum string length: 128

Example:

"scheme"

payment_method.store_payment_method

boolean

決済方法を保存する場合はTrue、保存しない場合はFalse（トークン化用）。

Example:

true

merchant_id

string

required

加盟店ID（DASMID）。

Maximum string length: 128

Example:

"< Merchant ID >"

billing_address

object

required

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

表示子属性

billing_address.country

string

カード所有者の請求先国コード。

Maximum string length: 2

Example:

"JP"

billing_address.email

string

カード所有者の請求先メールアドレス。

Maximum string length: 45

Example:

"[email protected]"

billing_address.phone_number

string

カード所有者の請求先電話番号。

Maximum string length: 20

Example:

"8112345678"

billing_address.address1

string

カード所有者の請求先住所。

Maximum string length: 199

Example:

"1-2-3 Shinjuku"

billing_address.city

string

カード所有者の請求先市区町村。

Maximum string length: 65

Example:

"Shinjuku-ku"

billing_address.state

string

カード所有者の請求先都道府県。

Maximum string length: 65

Example:

"Tokyo"

billing_address.postal_code

string

カード所有者の請求先郵便番号。

Maximum string length: 45

Example:

"1600022"

merchant_txn_ref

string

加盟店取引参照ID。

Maximum string length: 45

Example:

"qwe"

customer_ip

string

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

Maximum string length: 45

Example:

"127.0.0.1"

return_url

object

リターンURLを含むJSONオブジェクト。（このフィールドは3DS取引に必須）。

表示子属性

return_url.webhook_url

string

Webhook URLリンク。

Maximum string length: 255

Example:

"< Webhook url >"

return_url.success_url

string

支払い成功後のリダイレクトURL。

Maximum string length: 255

Example:

"http://www.successurl.com/"

return_url.decline_url

string

支払い失敗後のリダイレクトURL。

Maximum string length: 255

Example:

"http://www.declineurl.com/"

shipping_address

object

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

表示子属性

shipping_address.country

string

カード所有者の配送先国コード。

Maximum string length: 2

Example:

"JP"

shipping_address.email

string

カード所有者の配送先メールアドレス。

Maximum string length: 45

Example:

"[email protected]"

shipping_address.phone_number

string

カード所有者の配送先電話番号。

Maximum string length: 20

Example:

"8112345678"

shipping_address.address1

string

カード所有者の配送先住所。

Maximum string length: 199

Example:

"1-2-3 Shinjuku"

shipping_address.city

string

カード所有者の配送先市区町村。

Maximum string length: 65

Example:

"Shinjuku-ku"

shipping_address.state

string

カード所有者の配送先都道府県。

Maximum string length: 65

Example:

"Tokyo"

shipping_address.postal_code

string

カード所有者の配送先郵便番号。

Maximum string length: 45

Example:

"1600022"

time_zone

string

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

Maximum string length: 128

Example:

"Asia/Kuala_Lumpur"

Response

201 - application/json

支払いが正常に処理されました。

success

boolean

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

Example:

true

status_code

integer

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

Example:

201

is_live

boolean

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

Example:

false

transaction_type

string

取引の種類（例：CAPTURE）。

Example:

"CAPTURE"

gateway_response

object

ゲートウェイからのレスポンスを含むJSONオブジェクト。

表示子属性

gateway_response.version

string

ゲートウェイのバージョン。

Example:

"1"

gateway_response.type

string

レスポンスの種類（例：INFO）。

Example:

"INFO"

gateway_response.message

string

ゲートウェイからのメッセージレスポンス。

Example:

"Payment Successful."

gateway_response.code

string

レスポンスのメッセージコード。

Example:

"INFO0000"

merchant_details

object

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

表示子属性

merchant_details.legal_name

string

加盟店の正式名称。

Example:

"アイベック株式会社"

merchant_details.mid

string

加盟店ID（DASMID）。

Example:

"< Merchant ID >"

merchant_details.merchant_txn_ref

string

加盟店取引参照ID。

Example:

"qwe"

merchant_details.billing_details

object

請求情報を含むJSONオブジェクト。

表示子属性

merchant_details.billing_details.billing_address

object

請求先住所を含むJSONオブジェクト。

表示子属性

merchant_details.billing_details.billing_address.country

string

カード所有者の請求先国コード。

Example:

"JP"

merchant_details.billing_details.billing_address.email

string

カード所有者の請求先メールアドレス。

Example:

"[email protected]"

merchant_details.billing_details.billing_address.phone_number

string

カード所有者の請求先電話番号。

Example:

"8112345678"

merchant_details.billing_details.billing_address.address1

string

カード所有者の請求先住所。

Example:

"1-2-3 Shinjuku"

merchant_details.billing_details.billing_address.city

string

カード所有者の請求先市区町村。

Example:

"Shinjuku-ku"

merchant_details.billing_details.billing_address.state

string

カード所有者の請求先都道府県。

Example:

"Tokyo"

merchant_details.billing_details.billing_address.postal_code

string

カード所有者の請求先郵便番号。

Example:

"1600022"

merchant_details.device_details

object

デバイスの詳細情報を含むJSONオブジェクト。

表示子属性

merchant_details.device_details.visited_ip

string

決済ページのIPアドレス。

Example:

"127.0.0.1"

merchant_details.device_details.merchant_ip

string

加盟店のIPアドレスです。

Example:

"127.0.0.1"

merchant_details.device_details.customer_ip

string

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

Example:

"127.0.0.1"

payment_details

object

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

表示子属性

payment_details.amount

number

取引の金額値。

Example:

1000

payment_details.response_code

integer

アクワイアラーのレスポンスコード。

Example:

0

payment_details.auth_code

string

アクワイアラーの認可コード。

Example:

"268004"

payment_details.currency

string

取引の通貨。

Example:

"JPY"

payment_details.payment_method

string

支払いカードの種類（例: クレジットカード）。

Example:

"ECMC-SSL"

payment_details.scheme

string

カードブランドのスキーム（例: マスターカード）。

Example:

"MASTERCARD"

payment_details.card

object

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

表示子属性

payment_details.card.name

string

カード名義人の氏名。

Example:

"John Doe"

payment_details.card.number

string

カード番号（マスキング済み）。

Example:

"4000000000001091"

payment_details.card.exp_month

string

カードの有効期限（月）。

Example:

"12"

payment_details.card.exp_year

string

カードの有効期限（年）。

Example:

"29"

payment_details.additional_data

object

追加データを含むJSONオブジェクト。

表示子属性

payment_details.additional_data.payment_data_source

object

支払いデータソースを含むJSONオブジェクト。

表示子属性

payment_details.additional_data.payment_data_source.type

string

支払いデータソースの種類。

Example:

"card"

transaction_details

object

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

表示子属性

transaction_details.id

string

取引ID。

Example:

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

transaction_details.ref

integer

取引の認可コード。

Example:

74811

transaction_details.timestamp

string

取引の日時。

Example:

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

transaction_details.merchant_txn_ref

string

加盟店の取引参照ID。

Example:

"qwe"

transaction_details.stored_payment_method_id

string

保存済みの支払い方法ID（該当する場合）。

Example:

"094db781-fabc-4c6d-8fcd-18bee06a527a"

risk-details

object

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

表示子属性

risk-details.risk_score

string

リスクスコア（該当する場合）。

Example:

null

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

重要なポイント

フローダイアグラム

ノート

APIパラメータ

Authorizations

Body

Response

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

​重要なポイント

​フローダイアグラム

​ノート

​APIパラメータ

Authorizations

Body

Response

重要なポイント

フローダイアグラム

ノート

APIパラメータ