Skip to main content
PATCH
Update a Payment Link

Authorizations

X-Meridian-Signature
string
header
required

Meridian HMAC header authentication.

Required headers:

  • X-Meridian-Api-Key
  • X-Meridian-Timestamp
  • X-Meridian-Signature

X-Meridian-Signature is the HMAC SHA-256 signature of the canonical request string, computed per request as HMAC-SHA256(apiKey + timestamp + method + request URI including any query string + body). See Authentication for how to construct it.

Headers

X-Meridian-Api-Key
string
required

API key issued by Meridian during provisioning.

X-Meridian-Timestamp
string
required

Current time in milliseconds since the Unix epoch. Must be within 10 seconds of the request.

Path Parameters

id
string
required

Meridian id of the payment link.

Body

application/json

Request body to partially update a payment link. Only provided fields are changed.

Request body to partially update a payment link. Only provided fields are changed.

reason
string
required

Reason the payment link is being updated, recorded on the audit trail (non-blank, max 255 characters).

Maximum string length: 255
status
enum<string> | null

New status of the payment link, if provided.

Available options:
ACTIVE,
PROCESSING,
FAILED,
INACTIVE,
EXPIRED,
LOCKED,
ARCHIVED,
COMPLETED
creditAmount
string | null

New amount collected per charge, if provided, sent as a decimal string such as "300.00". Must be greater than zero. A JSON number is also accepted on input. On a VARIABLE link, supplying this field also triggers the next-collection-date lead check described under nextCollectionDate, even when you do not send that field.

Example:

"300.00"

referenceLabel
string | null

New human-readable label for the payment link, if provided (non-blank, max 64 characters).

Maximum string length: 64
description
string | null

New description for the payment link, if provided (max 255 characters).

Maximum string length: 255
referenceId
string | null

New merchant reference for the payment link, if provided (non-blank, max 255 characters). Must stay unique across the merchant's payment links with the same status; a collision currently surfaces as a 500 rather than a 409.

Maximum string length: 255
startDate
string<date> | null

New start date, if provided. Must be today or later.

endDate
string<date> | null

New end date, if provided. Must be after today and after the effective start date, which is the stored startDate when you do not send a new one.

collectionCount
integer | null

New number of installments to collect, if provided, between 1 and 500.

Required range: 1 <= x <= 500
nextCollectionDate
string<date> | null

Overrides the date of the next scheduled collection. Accepted only for VARIABLE payment links. When either this field or creditAmount is supplied, the effective next collection date, which falls back to the link's stored next payment date, must be at least 3 days in the future, and must not precede the effective start date.

customFields
Map_String_String · object | null

Replacement key-value map of custom fields, if provided. The supplied map replaces the stored one rather than being merged into it.

Response

Payment link updated successfully

Wrapper returned by the create and update payment link endpoints.

The created or updated payment link.