Off-Session Payment API

Off-session Payment APIはユーザーがpayment時にデバイスへアクセスしていない状態で決済するためのAPIです。既にcustomer_IDを発行している場合、ユーザーの関与なく引落が実行できます。 （customer_IDの発行についてはOn-session Payment APIをご確認ください）

POST/api.v1.PaymentService/OffSessionPayment→

▼buyer

email*Customer's email address

force_kyc*Whether to require KYC verification

nameCustomer's full name

▼charge

price*Amount to charge in JPY

description*Description of the charge

Request Body

{}

概要

Off-Session Payment APIは

• 既にcustomer IDを持っているユーザーに対してcharge(引落)を行えます
• charge時に必要な加盟店情報（加盟店決済ID, descriptor）等を付与できます

Off-Session Payment POST

エンドポイント

POST /api.v1.PaymentService/OffSessionPayment

リクエスト

Customer Object

Parameter	Type	Required	Description
customer_id	string	Required	Customer ID

Charge Object

Parameter	Type	Required	Description
price	number	Optional	Amount to charge in JPY
description	string	Optional	Description of the charge
metadata	object	Optional	Additional data for the charge

レスポンス

Success Response

{
  "charge": {
    "id": "chg-73d45202-c751-40ac-8b8d-52eb8b009f53",
    "price": 100,
    "description": "商品の説明",
    "metadata": {
      "order_id": "order_456"
    }
}

Response Fields

Field	Type	Description
charge.id	string	Always Unique identifier for the charge
charge.price	number	Always Amount to be charged in JPY
charge.metadata	object	Optional Additional data for the charge

エラーコード

INVALID_REQUEST

Missing or invalid parameters in the request

KYC_REQUIRED

Customer must complete KYC verification before proceeding

INVALID_AMOUNT

The charge amount is invalid or outside allowed range

シーケンス図