POST
/
api
/
v1
/
server-to-server-interface
/
hpp
/
generate
/
link
curl --request POST \
  --url https://api-dev.paymentoptions.com/api/v1/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/"
  },
  "amount": 1000,
  "currency": "JPY",
  "merchant_id": "< Merchant ID >",
  "merchant_email": "merchant@testemail.com",
  "merchant_txn_ref": "2003089893366DTEST",
  "billing_address": {
    "country": "JP",
    "email": "billing@testemail.com",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "shipping_address": {
    "country": "JP",
    "email": "shipping@testemail.com",
    "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": "merchant@testemail.com",
  "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": "billing@testemail.com",
    "phone_number": "8112345678",
    "state": "Tokyo",
    "country": "JP",
    "address1": "1-2-3 Shinjuku",
    "postal_code": "1600022"
  },
  "shipping_address": {
    "city": "Shinjuku-ku",
    "email": "shipping@testemail.com",
    "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から直接取引を完了できます。

​
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オブジェクト

​
currency
string
required

処理通貨（例：JPY）

Maximum length: 3
Example:

"JPY"

​
merchant_id
string
required

加盟店ID（DASMID）

Maximum length: 128
Example:

"< Merchant ID >"

​
merchant_email
string
required

加盟店のメールアドレス

Maximum length: 45
Example:

"merchant@testemail.com"

​
billing_address
object
required

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

​
amount
number

取引の金額

Example:

1000

​
merchant_txn_ref
string

加盟店の取引参照ID

Maximum length: 45
Example:

"2003089893366DTEST"

​
shipping_address
object

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

Response

200 - application/json
HPPリンクが正常に生成されました
​
id
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:

"merchant@testemail.com"

​
return_url
object

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

​
billing_address
object

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

​
shipping_address
object

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