API Reference

Update payment link

PATCH

https://api.zen.com/v1/payment-links/{id}

payment-links

Updtes one specific payment link, that allows to initiate the payment process with updated amount or currency etc.

Request

Path Params

string <uuid>

required

An unique identifier

Example:

3fa85f64-5717-4562-b3fc-2c963f66afa6

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

Body Params application/json

Payment link object that needs to be updated via checkout-api

hidden

boolean

optional

status

enum<string>

optional

Allowed value:

EXPIRED

Example

{
    "hidden": true,
    "status": "EXPIRED"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.zen.com/v1/payment-links/' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hidden": true,
    "status": "EXPIRED"
}'

Responses

🟢200OK

application/json

Body

Updated payment link status

status

boolean

optional

Example

{
    "status": true
}

🟠404Record Not Found

Modified at 2025-07-10 11:28:41

Fetch payment link

Create customer