メインコンテンツへスキップ
POST
/
api
/
v1
/
server-to-server-interface
/
hpp
/
generate
/
link
HPPリンクを生成
curl --request POST \
  --url https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/hpp/generate/link \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "return_url": {
    "webhook_url": "< Webhook url >",
    "success_url": "http://www.successurl.com/",
    "decline_url": "http://www.declineurl.com/",
    "cancel_url": "http://cancelurl.com/"
  },
  "currency": "JPY",
  "merchant_id": "< Merchant ID >",
  "merchant_email": "[email protected]",
  "payment_method": {
    "type": "scheme",
    "store_payment_method": true
  },
  "billing_address": {
    "country": "JP",
    "email": "[email protected]",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "amount": 1000,
  "merchant_txn_ref": "2003089893366DTEST",
  "shipping_address": {
    "country": "JP",
    "email": "[email protected]",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  }
}
'
{
  "id": "f49173ce-4916-445c-a831-3c1468acf14e",
  "url": "https://checkout-dev.paymentoptions.com/jp/HostedPaymentPage/hKJsdByR",
  "amount": 1000,
  "currency": "JPY",
  "merchant_txn_ref": "2003089893366DTEST",
  "merchant_id": "< Merchant ID >",
  "merchant_email": "[email protected]",
  "return_url": {
    "webhook_url": "< Webhook url >",
    "success_url": "http://www.successurl.com/",
    "decline_url": "http://www.declineurl.com/",
    "cancel_url": "http://cancelurl.com/"
  },
  "billing_address": {
    "city": "Shinjuku-ku",
    "email": "[email protected]",
    "phone_number": "8112345678",
    "state": "Tokyo",
    "country": "JP",
    "address1": "1-2-3 Shinjuku",
    "postal_code": "1600022"
  },
  "shipping_address": {
    "city": "Shinjuku-ku",
    "email": "[email protected]",
    "phone_number": "8112345678",
    "state": "Tokyo",
    "country": "JP",
    "address1": "1-2-3 Shinjuku",
    "postal_code": "1600022"
  }
}

​
重要なポイント

  • ペイロードにデータ（例：金額、通貨、顧客詳細、return_url、決済方法）が事前入力されている場合、これらの詳細はHPPに反映され、スムーズなユーザー体験を提供します。
  • ペイロードに必要なデータが欠けている場合、顧客はHPPで不足している情報を手動で入力する必要があります。
  • 必要なヘッダーと認証詳細が含まれていることを確認し、HPPリンクを正常に生成します。

​
フローダイアグラム

Flow diagram image

​
ノート

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パラメータ

承認

​
Authorization
string
header
必須

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

​
x-api-key
string
header
必須

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

ボディ

application/json

HPPリンクを生成するためのリクエストペイロード。

​
return_url
object
必須

リターンURLを含むJSONオブジェクト。

​
currency
string
必須

処理通貨（例：JPY）。

Maximum string length: 3
例:

"JPY"

​
merchant_id
string
必須

加盟店ID（DASMID）。

Maximum string length: 128
例:

"< Merchant ID >"

​
merchant_email
string
必須

加盟店のメールアドレス。

Maximum string length: 45
例:

"[email protected]"

​
payment_method
object
必須

支払い方法を含むJSONオブジェクト。

​
billing_address
object
必須

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

​
amount
number

取引の金額。

例:

1000

​
merchant_txn_ref
string

加盟店の取引参照ID。

Maximum string length: 45
例:

"2003089893366DTEST"

​
shipping_address
object

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

レスポンス

200 - application/json

HPPリンクが正常に生成されました

​
id
string

取引参照ID。

例:

"f49173ce-4916-445c-a831-3c1468acf14e"

​
url
string

生成されたホスト型決済ページ（HPP）リンクのURL。

例:

"https://checkout-dev.paymentoptions.com/jp/HostedPaymentPage/hKJsdByR"

​
amount
number

取引の金額。

例:

1000

​
currency
string

取引の処理通貨。

例:

"JPY"

​
merchant_txn_ref
string

加盟店の取引参照ID。

例:

"2003089893366DTEST"

​
merchant_id
string

実行された取引のDAS加盟店ID。

例:

"< Merchant ID >"

​
merchant_email
string

加盟店のメールアドレス。

例:

"[email protected]"

​
return_url
object

リターンURLを含むJSONオブジェクト。

​
billing_address
object

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

​
shipping_address
object

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