Skip to main content
PUT
Update v1 (Legacy)

Authorizations

Authorization
string
header
required

JWT issued by POST /api/v1.1/access-token/b2b. Send Authorization: Bearer <token>.

X-PARTNER-ID
string
header
required

Merchant API key (Credential.api_key). Required on every request.

Path Parameters

account_id
string
required

Account identifier in ULID format.

Payment link identifier (payment_links.id).

Body

application/json
max_usage
integer
required

Maximum number of times this link may be used for payment. Must be greater than or equal to the current usage count.

Required range: 1 <= x <= 1000000
Example:

1

status
enum<string>
required

Payment link lifecycle status.

Available options:
open,
closed,
expired
Example:

"open"

required_customer_detail
boolean

Whether customer details are required at checkout. If omitted, defaults to false.

Example:

true

expired_at
string | null

Optional expiration time as a Unix timestamp in milliseconds (13 digits).

Pattern: ^\d{13}$
Example:

"1705305600000"

whitelisted_payment_method
string[] | null

Restricts accepted payment methods for this link. Send an empty array to allow all active payment-link methods. Each entry must be a valid payment method code from the payment methods catalog.

redirect_url
string<uri> | null

Optional URL to redirect the payer after payment flow completion.

Maximum string length: 2048
Example:

"https://example.com/payment-link"

optional_metadata
object | null

Optional merchant-defined metadata for this payment link.

Example:

Response

Updated

status
integer
required

HTTP status code.

Example:

200

success
boolean
required

Indicates whether the request was successful.

Example:

true

data
object

Payment link resource payload.