Update a Payment Link
Apply partial changes to an existing payment link, including its amount, schedule, and status.
Authorizations
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
API key issued by Meridian during provisioning.
Current time in milliseconds since the Unix epoch. Must be within 10 seconds of the request.
Path Parameters
Meridian id of the payment link.
Body
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 the payment link is being updated, recorded on the audit trail (non-blank, max 255 characters).
255New status of the payment link, if provided.
ACTIVE, PROCESSING, FAILED, INACTIVE, EXPIRED, LOCKED, ARCHIVED, COMPLETED 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.
"300.00"
New human-readable label for the payment link, if provided (non-blank, max 64 characters).
64New description for the payment link, if provided (max 255 characters).
255New 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.
255New start date, if provided. Must be today or later.
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.
New number of installments to collect, if provided, between 1 and 500.
1 <= x <= 500Overrides 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.
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.