POportone
Payment APIs

Update Payment Link Status

Update the status of the Payment Link. Currently only updating the "cancelled" status is supported.

put/api/paymentLink/{payment_link_ref}/status/{link_status}

Request

  • Base URL
    https://api.portone.cloud
  • URL
    https://api.portone.cloud/api/paymentLink/{payment_link_ref}/status/{link_status}
  • Auth
    none declared

Path parameters

payment_link_refstring required
link_statusstring required

Headers

X-Portone-Client-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>

Response

Successful response

messagestring

The extra message about the transaction

status_codestring

The status_code for transaction of transaction creation

status_reasonstring

The status_reason for transaction of transaction creation

Changes

No recorded changes to this operation across all 2 revisions of this API.