Update the Payment Link

put

https://api.portone.cloud/api/update-paylink/{payment_link_ref}

Update a payment link. In response you will get the updated Payment Link details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payment_link_ref

string

required

Body Params

country_code

string

The country_code of transaction

amount

double

The amount of transaction, can be floating point number

currency

string

The currency of 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

The url of success page hosted by merchant.

failure_url

string

The url of failure page hosted by merchant.

pending_url

string

The url of pending page hosted by merchant.

merchant_details

object

The JSON object for adding merchant details

expiry_date

string

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

reminder_time

number

The integer number to configure the reminder

reminder_time_unit

string

The string value either 'hour' or 'day', to configure reminder using reminder_time field

scheduled_date

string

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

description

string

The description of the transaction

mobile_redirect_url

string

The URL used in the mobile redirection flow

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

default_guest_checkout

boolean

Boolean flag to setup the default guest checkout for this created payment link

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

is_billing_shipping_same

boolean

Boolean flag to configure the same billing and shipping address

show_items

boolean

Boolean flag to show items in checkout UI

show_saved_cards

boolean

Boolean flag to show the saved cards in the checkout UI

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.

customer_details

object

Customer Details object 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