Update the Payment Link

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

payment_link_refstring required

Content-Typestring

X-Portone-Client-Keystring

X-Portone-SubMerchant-Keystring

Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Request body

country_codestring

The country_code of transaction

amountnumber double

The amount of transaction, can be floating point number

currencystring

The currency of transaction

success_urlstring

The url of success page hosted by merchant.

failure_urlstring

The url of failure page hosted by merchant.

pending_urlstring

The url of pending page hosted by merchant.

expiry_datestring

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

reminder_timenumber

The integer number to configure the reminder

reminder_time_unitstring

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

scheduled_datestring

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

descriptionstring

The description of the transaction

mobile_redirect_urlstring

The URL used in the mobile redirection flow

show_shipping_detailsboolean

Boolean flag to show shipping details in Checkout page

show_back_buttonboolean

Boolean flag to show back button in Checkout page

default_guest_checkoutboolean

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

is_checkout_embedboolean

Boolean flag to enable checkout embedding

notify_by_emailboolean

Boolean flag to notify customer by email

notify_by_phoneboolean

Boolean flag to notify customer by phone

is_billing_shipping_sameboolean

Boolean flag to configure the same billing and shipping address

show_itemsboolean

Boolean flag to show items in checkout UI

show_saved_cardsboolean

Boolean flag to show the saved cards in the checkout UI

user_configured_field1string

The User configured field 1 for the payment link.

user_configured_field2string

The User configured field 2 for the payment link.

user_configured_field3string

The User configured field 3 for the payment link.

user_configured_field4string

The User configured field 4 for the payment link.

user_configured_field5string

The User configured field 5 for the payment link.

use_merchant_configured_dcc_rateboolean

Boolean flag to specify to use the merchant configured dcc rate

Example request

{
  "billing_details": {
    "billing_name": "First Middle",
    "billing_surname": "Last",
    "billing_email": "test@gmail.com",
    "billing_phone": "8959893980",
    "billing_address": {
      "city": "Singapore",
      "country_code": "SG",
      "country_name": "Singapore",
      "locale": "en",
      "line_1": "20 WOODLANDS",
      "line_2": "LINK 04-20",
      "postal_code": "738733",
      "state": "Singapore"
    }
  },
  "shipping_details": {
    "shipping_name": "First Middle",
    "shipping_surname": "Last",
    "shipping_email": "test@gmail.com",
    "shipping_phone": "8959893980",
    "shipping_address": {
      "city": "Singapore",
      "country_code": "SG",
      "country_name": "Singapore",
      "locale": "en",
      "line_1": "20 WOODLANDS",
      "line_2": "LINK 04-20",
      "postal_code": "738733",
      "state": "Singapore"
    }
  },
  "merchant_details": {
    "name": "Nike",
    "back_url": "https://demo.portone.cloud/checkout.html",
    "promo_code": "testcode"
  }
}

Response

Successful response