Hosted Payment Page

Generate HPP Link

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

Generate HPP Link

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

Key Points

If the payload is pre-filled with data (e.g., amount, currency, customer details, return_url, payment method), these details will be reflected on the HPP, providing a streamlined user experience.
If the payload lacks certain data, the customer will need to manually enter the missing information on the HPP.
Ensure that the necessary headers and authentication details are included to successfully generate the HPP link.

Flow diagram

ApplePay & GooglePay

When a merchant is configured for Apple Pay and Google Pay, the Hosted Payment Page (HPP) will display buttons for Google Pay and Apple Pay, allowing customers to complete payments through these methods

Key Points

Merchant Configuration The Merchant ID for either Apple Pay or Google Pay must be included in the HPP payload when making a request to generate the payment link.These payment options will automatically appear on the HPP if the merchant is properly configured for them.Payment Buttons The HPP will dynamically display Google Pay and Apple Pay buttons based on the availability and configuration of the merchant’s account.Customers can seamlessly use either method to complete the transaction directly from the HPP.If both Apple Pay and Google Pay are configured for the same merchant (i.e., same DAS MID), you can control button priority by including the following optional parameter in the HPP payload:When set to true, this will prioritize displaying Google Pay on the payment interface. If omitted, the default prioritization will apply based on device and browser compatibility.

Api Parameters

Authorizations

Authorization

string

header

required

API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'

x-api-key

string

header

required

API Key specific to x-api-key.

Body

application/json

The request payload to generate an HPP link.

return_url

object

required

A JSON object containing the Return URLs.

Show child attributes

return_url.webhook_url

string

The webhook URL for asynchronous notifications.

Maximum string length: 255

Example:

"< Webhook url >"

return_url.success_url

string

The URL to redirect the user to after a successful payment.

Maximum string length: 255

Example:

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

return_url.decline_url

string

The URL to redirect the user to after a failed payment.

Maximum string length: 255

Example:

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

return_url.cancel_url

string

The URL to redirect the user to if the payment is canceled.

Maximum string length: 255

Example:

"http://cancelurl.com/"

currency

string

required

The processing currency (e.g., JPY).

Maximum string length: 3

Example:

"JPY"

merchant_id

string

required

The merchant ID (DASMID).

Maximum string length: 128

Example:

"< Merchant ID >"

merchant_email

string

required

The email address of the Merchant.

Maximum string length: 45

Example:

"[email protected]"

billing_address

object

required

A JSON object containing the billing address of the cardholder.

Show child attributes

billing_address.country

string

The cardholder’s billing country code.

Maximum string length: 2

Example:

"JP"

billing_address.email

string

The cardholder’s billing email address.

Maximum string length: 45

Example:

"[email protected]"

billing_address.phone_number

string

The cardholder’s billing phone number.

Maximum string length: 15

Example:

"8112345678"

billing_address.address1

string

The cardholder’s billing address line.

Maximum string length: 199

Example:

"1-2-3 Shinjuku"

billing_address.city

string

The cardholder’s billing city.

Maximum string length: 65

Example:

"Shinjuku-ku"

billing_address.state

string

The cardholder’s billing state.

Maximum string length: 65

Example:

"Tokyo"

billing_address.postal_code

string

The cardholder’s billing postal code.

Maximum string length: 45

Example:

"1600022"

amount

number

The amount of the transaction.

Example:

1000

merchant_txn_ref

string

The merchant transaction reference ID.

Maximum string length: 45

Example:

"2003089893366DTEST"

shipping_address

object

A JSON object containing the shipping address of the cardholder.

Show child attributes

shipping_address.country

string

The cardholder’s shipping country code.

Maximum string length: 2

Example:

"JP"

shipping_address.email

string

The cardholder’s shipping email address.

Maximum string length: 45

Example:

"[email protected]"

shipping_address.phone_number

string

The cardholder’s shipping phone number.

Maximum string length: 20

Example:

"8112345678"

shipping_address.address1

string

The cardholder’s shipping address line.

Maximum string length: 199

Example:

"1-2-3 Shinjuku"

shipping_address.city

string

The cardholder’s shipping city.

Maximum string length: 65

Example:

"Shinjuku-ku"

shipping_address.state

string

The cardholder’s shipping state.

Maximum string length: 65

Example:

"Tokyo"

shipping_address.postal_code

string

The cardholder’s shipping postal code.

Maximum string length: 45

Example:

"1600022"

Response

200 - application/json

HPP link generated successfully

string

The transaction reference ID.

Example:

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

url

string

The URL Link of the hosted payment page link generated.

Example:

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

amount

number

The amount of the transaction.

Example:

1000

currency

string

The processing currency of the transaction.

Example:

"JPY"

merchant_txn_ref

string

The merchant transaction reference ID.

Example:

"2003089893366DTEST"

merchant_id

string

The DAS merchant ID of the transaction performed.

Example:

"< Merchant ID >"

merchant_email

string

The email address of the Merchant.

Example:

"[email protected]"

return_url

object

A JSON object containing the Return URL.

Show child attributes

return_url.webhook_url

string

The webhook URL for asynchronous notifications.

Example:

"< Webhook url >"

return_url.success_url

string

The URL to redirect the user to after a successful payment.

Example:

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

return_url.decline_url

string

The URL to redirect the user to after a failed payment.

Example:

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

return_url.cancel_url

string

The URL to redirect the user to if the payment is canceled.

Example:

"http://cancelurl.com/"

billing_address

object

A JSON object containing the billing address of the cardholder.

Show child attributes

billing_address.city

string

The cardholder’s billing city.

Example:

"Shinjuku-ku"

billing_address.email

string

The cardholder’s billing email address.

Example:

"[email protected]"

billing_address.phone_number

string

The cardholder’s billing phone number.

Example:

"8112345678"

billing_address.state

string

The cardholder’s billing state.

Example:

"Tokyo"

billing_address.country

string

The cardholder’s billing country code.

Example:

"JP"

billing_address.address1

string

The cardholder’s billing address line.

Example:

"1-2-3 Shinjuku"

billing_address.postal_code

string

The cardholder’s billing postal code.

Example:

"1600022"

shipping_address

object

A JSON object containing the shipping address of the cardholder.

Show child attributes

shipping_address.city

string

The cardholder’s shipping city.

Example:

"Shinjuku-ku"

shipping_address.email

string

The cardholder’s shipping email address.

Example:

"[email protected]"

shipping_address.phone_number

string

The cardholder’s shipping phone number.

Example:

"8112345678"

shipping_address.state

string

The cardholder’s shipping state.

Example:

"Tokyo"

shipping_address.country

string

The cardholder’s shipping country code.

Example:

"JP"

shipping_address.address1

string

The cardholder’s shipping address line.

Example:

"1-2-3 Shinjuku"

shipping_address.postal_code

string

The cardholder’s shipping postal code.

Example:

"1600022"

E-Wallet Tokenization

⌘I

Getting Started

API Endpoints

Error and Response

Webhook

Key Points

Flow diagram

ApplePay & GooglePay

Key Points

Api Parameters

Authorizations

Body

Response

Getting Started

API Endpoints

Error and Response

Webhook

​Key Points

​Flow diagram

​ApplePay & GooglePay

​Key Points

​Api Parameters

Authorizations

Body

Response

Key Points

Flow diagram

ApplePay & GooglePay

Key Points

Api Parameters