Create Payment Link

post

https://api.portone.cloud/api/paymentLink

Create a payment link. In response you will get the Payment Link reference and the Payment link URL. You can share the payment link with your customer. The master merchant can also create the payment link for their sub-merchants, by passing the sub-merchant key as a header. Refer API docs for additional information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

portone_key

string

required

The unique PortOne key for merchant

merchant_details

object

required

The JSON object for adding merchant details

merchant_order_id

string

required

The unique Merchant Order reference generated by merchant

signature_hash

string

required

The signature_hash of payment link details generated as per Payment Link Request Signature Documentation

environment

string

enum

required

The environment of transaction either live OR sandbox

Allowed:

amount

double

required

The amount of transaction, can be floating point number

currency

string

required

The currency of transaction

country_code

string

required

The country_code of transaction

description

string

The description of the transaction

billing_details

object

The JSON object for billing details

shipping_details

object

The JSON object for shipping details

order_details

array of objects

The JSON array for order details

Orders object

success_url

string

required

The url of success page hosted by merchant.

failure_url

string

required

The url of failure page hosted by merchant.

pending_url

string

The url of pending page hosted by merchant.

expiry_date

string

Date and time to expire the payment link in UTC format.

source

string

required

'default', 'api' or 'checkout' -- The Source of Payment Link creation.

show_shipping_details

boolean

Boolean flag to show shipping details in Checkout page

show_back_button

boolean

Boolean flag to show back button in Checkout page

is_checkout_embed

boolean

Boolean flag to enable checkout embedding

notify_by_email

boolean

Boolean flag to notify customer by email

notify_by_phone

boolean

Boolean flag to notify customer by phone

notes

array of objects

Notes object used for additional fields

custom_txn_webhook_urls

array

The array of string havind webhook endpoint URLs

custom_txn_webhook_urls

user_configured_field1

string

The User configured field 1 for the payment link.

user_configured_field2

string

The User configured field 2 for the payment link.

user_configured_field3

string

The User configured field 3 for the payment link.

user_configured_field4

string

The User configured field 4 for the payment link.

user_configured_field5

string

The User configured field 5 for the payment link.

use_merchant_configured_dcc_rate

boolean

Boolean flag to specify to use the merchant configured dcc rate

merchant_dcc_rate

object

The JSON object for merchant configured DCC Rates data

Headers

Content-Type

string

X-Portone-Client-Key

string

X-Portone-SubMerchant-Key

string

Authorization

string

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token in this guide

Responses

200Successful response

401Failure response