Edit and version a checkout payment link

curl --request PATCH \
  --url https://server.hypermid.io/v1/payments/links/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chain": 8453,
  "token": "<string>",
  "recipient": "<string>",
  "amount": "25000000",
  "singleUse": false,
  "metadata": {},
  "successUrl": "<string>",
  "cancelUrl": "<string>",
  "expiresAt": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chain: 8453,
    token: '<string>',
    recipient: '<string>',
    amount: '25000000',
    singleUse: false,
    metadata: {},
    successUrl: '<string>',
    cancelUrl: '<string>',
    expiresAt: '<string>'
  })
};

fetch('https://server.hypermid.io/v1/payments/links/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://server.hypermid.io/v1/payments/links/{id}"

payload = {
    "chain": 8453,
    "token": "<string>",
    "recipient": "<string>",
    "amount": "25000000",
    "singleUse": False,
    "metadata": {},
    "successUrl": "<string>",
    "cancelUrl": "<string>",
    "expiresAt": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "OK",
  "error": null,
  "data": {
    "id": "plink_01K…",
    "version": 123,
    "mode": "checkout",
    "environment": "<string>",
    "chain": {},
    "token": {},
    "recipient": {},
    "amount": "<string>",
    "singleUse": true,
    "metadata": {},
    "successUrl": {},
    "cancelUrl": {},
    "expiresAt": {},
    "revokedAt": {},
    "consumedBySessionId": {},
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "cancelledSessions": 123
  }
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

PATCH

payments

links

{id}

Edit and version a checkout payment link

curl --request PATCH \
  --url https://server.hypermid.io/v1/payments/links/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chain": 8453,
  "token": "<string>",
  "recipient": "<string>",
  "amount": "25000000",
  "singleUse": false,
  "metadata": {},
  "successUrl": "<string>",
  "cancelUrl": "<string>",
  "expiresAt": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chain: 8453,
    token: '<string>',
    recipient: '<string>',
    amount: '25000000',
    singleUse: false,
    metadata: {},
    successUrl: '<string>',
    cancelUrl: '<string>',
    expiresAt: '<string>'
  })
};

fetch('https://server.hypermid.io/v1/payments/links/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://server.hypermid.io/v1/payments/links/{id}"

payload = {
    "chain": 8453,
    "token": "<string>",
    "recipient": "<string>",
    "amount": "25000000",
    "singleUse": False,
    "metadata": {},
    "successUrl": "<string>",
    "cancelUrl": "<string>",
    "expiresAt": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "OK",
  "error": null,
  "data": {
    "id": "plink_01K…",
    "version": 123,
    "mode": "checkout",
    "environment": "<string>",
    "chain": {},
    "token": {},
    "recipient": {},
    "amount": "<string>",
    "singleUse": true,
    "metadata": {},
    "successUrl": {},
    "cancelUrl": {},
    "expiresAt": {},
    "revokedAt": {},
    "consumedBySessionId": {},
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "cancelledSessions": 123
  }
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

Authorizations

Authorization

string

header

required

Secret partner API key (sk_live_… or sk_test_…). Required to create or manage payment sessions. Server-side only — it can move money, so it must never reach a browser bundle. The key's prefix also selects the environment: sk_test_ is confined to testnets.

Path Parameters

string

required

Body

application/json

chain

number

Registered checkout destination chain.

Example:

8453

token

string

Registered checkout destination token.

recipient

string

Registered payout recipient; must be allowlisted.

amount

string

Fixed price in destination-token base units.

Example:

"25000000"

singleUse

boolean

default:false

FIRST-CONFIRMED-WINS invoice semantics.

metadata

object

Optional merchant metadata copied to the link.

successUrl

string

Optional URL for the hosted page to use after a successful payment.

cancelUrl

string

Optional URL for the hosted page to use when payment is cancelled.

expiresAt

string

Merchant-controlled link expiry (ISO 8601).

Response

Payment link updated; unpaid prior-version sessions cancelled.

traceId

string

required

W3C trace id of the request — correlate with logs/traces in SigNoz.

Example:

"4bf92f3577b34da6a3ce929d0e0e4736"

code

enum<string>

required

Domain error code. OK on success; non-OK values come with a non-null error.

Available options:

OK,

BAD_REQUEST,

UNAUTHORIZED,

FORBIDDEN,

NOT_FOUND,

CONFLICT,

RATE_LIMITED,

PAYLOAD_TOO_LARGE,

UNSUPPORTED_CHAIN,

INTERNAL_ERROR,

UPSTREAM_TIMEOUT,

UPSTREAM_ERROR,

SERVICE_UNAVAILABLE,

KILL_SWITCH_ACTIVE,

CIRCUIT_BREAKER_OPEN,

NO_QUOTE_AVAILABLE,

QUOTE_STALE,

SIMULATION_REVERTED,

INVALID_PARAMS,

AMOUNT_OUT_OF_BOUNDS,

PAYOUT_TOKEN_NOT_ALLOWED,

RECIPIENT_NOT_ALLOWLISTED,

PAYMENT_EXPIRED,

PAYMENT_NOT_FOUND,

NOT_CONFIGURED,

INSUFFICIENT_LIQUIDITY,

ROUTE_TEMPORARILY_UNAVAILABLE,

UNSUPPORTED_ROUTE,

OVER_DELIVERY_CAP

Example:

"OK"

error

string | null

required

Human-readable error message. null on success.

Example:

null

data

object

required

Endpoint-specific payload. null on error.

Show child attributes

Overview

Endpoints

Webhooks

Edit and version a checkout payment link

Authorizations

Path Parameters

Body

Response