電子ウォレット

ホスト型決済ページ（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 '
{
  "amount": "1000",
  "currency": "PHP",
  "merchant_id": "< Webhook url >",
  "return_url": {
    "webhook_url": "< Webhook url >",
    "success_url": "http://www.successurl.com/",
    "decline_url": "http://www.declineurl.com/",
    "cancel_url": "http://cancelurl.com/"
  },
  "payment_method": {
    "type": "gcash"
  },
  "merchant_txn_ref": "qwe",
  "customer_ip": "127.0.0.1",
  "billing_address": {
    "country": "JP",
    "email": "[email protected]",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "shipping_address": {
    "country": "JP",
    "email": "[email protected]",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "time_zone": "Asia/Kuala_Lumpur"
}
'

{
  "id": "c0728395-6a55-4f10-819e-03bdc917c4b1",
  "url": "https://checkout-dev.paymentoptions.com/HostedPaymentPage/GGNDZOmv",
  "amount": 1000,
  "currency": "PHP",
  "merchant_txn_ref": "qwe",
  "merchant_id": "< Webhook url >",
  "merchant_email": null,
  "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]",
    "state": "Tokyo",
    "country": "JP",
    "address1": "1-2-3 Shinjuku",
    "postal_code": "1600022",
    "phone_number": "8112345678"
  },
  "shipping_address": {
    "city": "Shinjuku-ku",
    "email": "[email protected]",
    "state": "Tokyo",
    "country": "JP",
    "address1": "1-2-3 Shinjuku",
    "postal_code": "1600022",
    "phone_number": "8112345678"
  }
}

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 '
{
  "amount": "1000",
  "currency": "PHP",
  "merchant_id": "< Webhook url >",
  "return_url": {
    "webhook_url": "< Webhook url >",
    "success_url": "http://www.successurl.com/",
    "decline_url": "http://www.declineurl.com/",
    "cancel_url": "http://cancelurl.com/"
  },
  "payment_method": {
    "type": "gcash"
  },
  "merchant_txn_ref": "qwe",
  "customer_ip": "127.0.0.1",
  "billing_address": {
    "country": "JP",
    "email": "[email protected]",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "shipping_address": {
    "country": "JP",
    "email": "[email protected]",
    "phone_number": "8112345678",
    "address1": "1-2-3 Shinjuku",
    "city": "Shinjuku-ku",
    "state": "Tokyo",
    "postal_code": "1600022"
  },
  "time_zone": "Asia/Kuala_Lumpur"
}
'

{
  "id": "c0728395-6a55-4f10-819e-03bdc917c4b1",
  "url": "https://checkout-dev.paymentoptions.com/HostedPaymentPage/GGNDZOmv",
  "amount": 1000,
  "currency": "PHP",
  "merchant_txn_ref": "qwe",
  "merchant_id": "< Webhook url >",
  "merchant_email": null,
  "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]",
    "state": "Tokyo",
    "country": "JP",
    "address1": "1-2-3 Shinjuku",
    "postal_code": "1600022",
    "phone_number": "8112345678"
  },
  "shipping_address": {
    "city": "Shinjuku-ku",
    "email": "[email protected]",
    "state": "Tokyo",
    "country": "JP",
    "address1": "1-2-3 Shinjuku",
    "postal_code": "1600022",
    "phone_number": "8112345678"
  }
}

重要なポイント

加盟店設定

GCashの加盟店ID は、ペイロードに含め、payment_method タイプを gcash に設定する必要があります。
加盟店がGCashに設定されている場合、HPPはEウォレット決済リンクを生成し、顧客がGCashを通じて支払いを完了できるようにします。サポートされているEウォレットのすべてを表示…

Eウォレットリンク

HPPは、顧客がGCashを通じて支払うオプションを表示するか、顧客が使用できるEウォレットリンクを生成して提供します。
これにより、GCash Eウォレットを使用して取引を完了する顧客にとってスムーズなプロセスが確保されます。

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リンクを生成するためのペイロード。

amount

string

required

取引の金額。空の文字列として渡された場合、カード所有者がHPP上で手動で金額を入力します。

Example:

"1000"

currency

string

required

取引の処理通貨の略称（例：PHP＝フィリピンペソ）。

Maximum string length: 3

Example:

"PHP"

merchant_id

string

required

加盟店のユニーク識別子（DASMID）。

Maximum string length: 128

Example:

"< Webhook url >"

return_url

object

required

リターンURLを含むJSONオブジェクト。（このフィールドは3Dセキュア取引で必須です。）

表示子属性

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

payment_method

object

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

表示子属性

payment_method.type

string

決済方法の種類（例：ウォレットの場合「gcash」）。

Maximum string length: 128

Example:

"gcash"

merchant_txn_ref

string

加盟店の取引参照ID。

Maximum string length: 45

Example:

"qwe"

customer_ip

string

取引を開始する顧客のIPアドレス。

Example:

"127.0.0.1"

billing_address

object

カード所有者の請求先住所を含む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"

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

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

取引のタイムゾーン。

Example:

"Asia/Kuala_Lumpur"

Response

200 - application/json

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

string

取引参照ID。

Example:

"c0728395-6a55-4f10-819e-03bdc917c4b1"

url

string

生成されたホスト決済ページのURL。

Example:

"https://checkout-dev.paymentoptions.com/HostedPaymentPage/GGNDZOmv"

amount

integer

取引金額。

Example:

1000

currency

string

処理通貨。

Example:

"PHP"

merchant_txn_ref

string

加盟店取引参照ID。

Example:

"qwe"

merchant_id

string

取引の加盟店ID。

Example:

"< Webhook url >"

merchant_email

string

加盟店のメールアドレス（利用可能な場合）。

Example:

null

return_url

object

取引結果のリターンURL。

表示子属性

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

請求先住所の詳細。

表示子属性

billing_address.city

string

請求先の市区町村。

Example:

"Shinjuku-ku"

billing_address.email

string

請求先メールアドレス。

Example:

"[email protected]"

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"

billing_address.phone_number

string

請求先の電話番号。

Example:

"8112345678"

shipping_address

object

配送先住所の詳細。

表示子属性

shipping_address.city

string

配送先の市区町村。

Example:

"Shinjuku-ku"

shipping_address.email

string

配送先メールアドレス。

Example:

"[email protected]"

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"

shipping_address.phone_number

string

配送先の電話番号。

Example:

"8112345678"

サブスクリプション詳細API ホスト型決済ページ

⌘I

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

重要なポイント

Authorizations

Body

Response

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

​重要なポイント

Authorizations

Body

Response

重要なポイント