E-Wallet

Generate Hosted Payment Page (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 '
{
  "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

Generate Hosted Payment Page (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 '
{
  "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"
  }
}

Key Points

Merchant Configuration

The Merchant ID for GCash must be included in the payload along with the specific payment_method type set to gcash.
If the merchant is configured for GCash, the HPP will generate an E-Wallet payment link to enable customers to pay via GCash. See all supported E-Wallets…

E-Wallet Link

The HPP will display an option for customers to pay via GCash or generate an E-Wallet link for the customer to use.
This ensures a smooth process for customers using their GCash E-Wallet to complete transactions.

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 payload to generate an HPP link.

amount

string

required

The amount of the transaction. If passed as an empty string, the cardholder enters the amount manually on the HPP.

Example:

"1000"

currency

string

required

The abbreviation of the processing currency (e.g., PHP for Philippine Peso).

Maximum string length: 3

Example:

"PHP"

merchant_id

string

required

The unique identifier of the merchant (DASMID).

Maximum string length: 128

Example:

"< Webhook url >"

return_url

object

required

A JSON object containing the return URLs. (This field is mandatory for 3DS transactions.)

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 transaction.

Maximum string length: 255

Example:

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

return_url.decline_url

string

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

Maximum string length: 255

Example:

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

return_url.cancel_url

string

The URL to redirect the user to after a canceled transaction.

Maximum string length: 255

Example:

"http://cancelurl.com/"

payment_method

object

A JSON object containing payment method details.

Show child attributes

payment_method.type

string

The payment method type (e.g., 'gcash' for wallets).

Maximum string length: 128

Example:

"gcash"

merchant_txn_ref

string

The merchant transaction reference ID.

Maximum string length: 45

Example:

"qwe"

customer_ip

string

The IP address of the customer initiating the transaction.

Example:

"127.0.0.1"

billing_address

object

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"

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

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"

time_zone

string

The time zone for the transaction.

Example:

"Asia/Kuala_Lumpur"

Response

200 - application/json

HPP link generated successfully.

string

The transaction reference ID.

Example:

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

url

string

The URL of the generated Hosted Payment Page.

Example:

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

amount

integer

The transaction amount.

Example:

1000

currency

string

The processing currency.

Example:

"PHP"

merchant_txn_ref

string

The merchant transaction reference ID.

Example:

"qwe"

merchant_id

string

The merchant ID for the transaction.

Example:

"< Webhook url >"

merchant_email

string

The merchant's email address (if available).

Example:

null

return_url

object

The return URLs for transaction outcomes.

Show child attributes

return_url.webhook_url

string

The webhook URL for notifications.

Example:

"< Webhook url >"

return_url.success_url

string

The success URL.

Example:

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

return_url.decline_url

string

The decline URL.

Example:

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

return_url.cancel_url

string

The cancel URL.

Example:

"http://cancelurl.com/"

billing_address

object

The billing address details.

Show child attributes

billing_address.city

string

The billing city.

Example:

"Shinjuku-ku"

billing_address.email

string

The billing email address.

Example:

"[email protected]"

billing_address.state

string

The billing state.

Example:

"Tokyo"

billing_address.country

string

The billing country.

Example:

"JP"

billing_address.address1

string

The billing address line.

Example:

"1-2-3 Shinjuku"

billing_address.postal_code

string

The billing postal code.

Example:

"1600022"

billing_address.phone_number

string

The billing phone number.

Example:

"8112345678"

shipping_address

object

The shipping address details.

Show child attributes

shipping_address.city

string

The shipping city.

Example:

"Shinjuku-ku"

shipping_address.email

string

The shipping email address.

Example:

"[email protected]"

shipping_address.state

string

The shipping state.

Example:

"Tokyo"

shipping_address.country

string

The shipping country.

Example:

"JP"

shipping_address.address1

string

The shipping address line.

Example:

"1-2-3 Shinjuku"

shipping_address.postal_code

string

The shipping postal code.

Example:

"1600022"

shipping_address.phone_number

string

The shipping phone number.

Example:

"8112345678"

Subscription Details API Hosted Payment Page

⌘I

Getting Started

API Endpoints

Error and Response

Webhook

Key Points

Authorizations

Body

Response

Getting Started

API Endpoints

Error and Response

Webhook

​Key Points

Authorizations

Body

Response

Key Points