ホスト型決済ページ

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]",
  "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"
  }
}

POST

api

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]",
  "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リンクを正常に生成します。

フローダイアグラム

ApplePay & GooglePay

加盟店がApple PayおよびGoogle Payに対応している場合、ホスト型決済ページ（HPP）にはGoogle PayおよびApple Payのボタンが表示され、顧客はこれらの方法で支払いを完了できます。

重要なポイント

加盟店の設定Apple PayまたはGoogle Payのいずれかの加盟店IDを、決済リンクを生成するリクエストの際にHPPペイロードに含める必要があります。加盟店が正しく設定されている場合、これらの決済方法は自動的にHPPに表示されます。決済ボタンHPPは、加盟店のアカウントの利用可能性と設定に基づいて、Google PayおよびApple Payのボタンを動的に表示します。顧客は、どちらかの方法をシームレスに使用して、HPPから直接取引を完了できます。同じ加盟店（つまり、同一のDAS MID）に対してApple PayとGoogle Payの両方が設定されている場合、以下のオプションパラメーターをHPPペイロードに含めることで、表示するボタンの優先順位を制御できます:この値を true に設定すると、決済画面上でGoogle Payが優先的に表示されます。省略された場合は、デバイスおよびブラウザの互換性に基づいてデフォルトの優先順位が適用されます。

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

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

return_url

object

required

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

表示子属性

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/"

return_url.cancel_url

string

決済がキャンセルされた場合にユーザーをリダイレクトするURL

Maximum string length: 255

Example:

"http://cancelurl.com/"

currency

string

required

処理通貨（例：JPY）

Maximum string length: 3

Example:

"JPY"

merchant_id

string

required

加盟店ID（DASMID）

Maximum string length: 128

Example:

"< Merchant ID >"

merchant_email

string

required

加盟店のメールアドレス

Maximum string length: 45

Example:

"[email protected]"

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: 15

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"

amount

number

取引の金額

Example:

1000

merchant_txn_ref

string

加盟店の取引参照ID

Maximum string length: 45

Example:

"2003089893366DTEST"

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"

Response

200 - application/json

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

string

取引参照ID

Example:

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

url

string

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

Example:

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

amount

number

取引の金額

Example:

1000

currency

string

取引の処理通貨

Example:

"JPY"

merchant_txn_ref

string

加盟店の取引参照ID

Example:

"2003089893366DTEST"

merchant_id

string

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

Example:

"< Merchant ID >"

merchant_email

string

加盟店のメールアドレス

Example:

"[email protected]"

return_url

object

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

表示子属性

return_url.webhook_url

string

非同期通知用のWebhook URL

Example:

"< Webhook url >"

return_url.success_url

string

決済成功後にユーザーをリダイレクトするURL

Example:

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

return_url.decline_url

string

決済失敗後にユーザーをリダイレクトするURL

Example:

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

return_url.cancel_url

string

決済がキャンセルされた場合にユーザーをリダイレクトするURL

Example:

"http://cancelurl.com/"

billing_address

object

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

表示子属性

billing_address.city

string

カード所有者の請求先都市

Example:

"Shinjuku-ku"

billing_address.email

string

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

Example:

"[email protected]"

billing_address.phone_number

string

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

Example:

"8112345678"

billing_address.state

string

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

Example:

"Tokyo"

billing_address.country

string

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

Example:

"JP"

billing_address.address1

string

カード所有者の請求先住所の詳細

Example:

"1-2-3 Shinjuku"

billing_address.postal_code

string

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

Example:

"1600022"

shipping_address

object

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

表示子属性

shipping_address.city

string

カード所有者の配送先都市

Example:

"Shinjuku-ku"

shipping_address.email

string

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

Example:

"[email protected]"

shipping_address.phone_number

string

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

Example:

"8112345678"

shipping_address.state

string

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

Example:

"Tokyo"

shipping_address.country

string

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

Example:

"JP"

shipping_address.address1

string

カード所有者の配送先住所の詳細

Example:

"1-2-3 Shinjuku"

shipping_address.postal_code

string

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

Example:

"1600022"

電子ウォレットトークン化

⌘I

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

重要なポイント

フローダイアグラム

ApplePay & GooglePay

重要なポイント

APIパラメータ

Authorizations

Body

Response

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

​重要なポイント

​フローダイアグラム

​ApplePay & GooglePay

​重要なポイント

​APIパラメータ

Authorizations

Body

Response

重要なポイント

フローダイアグラム

ApplePay & GooglePay

重要なポイント

APIパラメータ