Skip to main content
PUT
/
checkout
/
links
/
{id}
Atualizar checkout link
curl --request PUT \
  --url https://checkout-api.sandbox.z2pay.com/checkout/links/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "slug": "<string>",
  "mode": "payment",
  "currency": "BRL",
  "locale": "pt-BR",
  "items": [],
  "paymentMethods": {},
  "splits": [
    {
      "recipientId": "<string>",
      "percentage": 50.005,
      "liable": true
    }
  ],
  "branding": {
    "primaryColor": "<string>",
    "logoUrl": "<string>",
    "merchantName": "<string>",
    "faviconUrl": "<string>",
    "coverUrl": "<string>"
  },
  "subscription": {
    "planId": "<string>",
    "currency": "<string>",
    "trialDays": 182,
    "maxCycles": 1,
    "collectionTiming": "prepaid",
    "metadata": {},
    "itemCovers": {},
    "maxEnrollmentInstallments": 1
  },
  "requiredFields": [],
  "customFields": [
    {
      "key": "<string>",
      "label": "<string>",
      "options": [
        "<string>"
      ],
      "required": true
    }
  ],
  "successUrl": "<string>",
  "cancelUrl": "<string>",
  "metadata": {},
  "expirationMinutes": 21602
}
'

Authorizations

​
x-api-key
string
header
required

CheckoutCredential — sk_* (backend) / pk_* (frontend público)

Path Parameters

​
id
string
required

ID do CheckoutLink

Body

application/json
​
name
string | null
Maximum string length: 255
​
description
string | null
Maximum string length: 2000
​
slug
string | null
Required string length: 3 - 100
Pattern: ^[a-z0-9-]+$
​
mode
enum<string>
default:payment
Available options:
payment,
subscription
​
currency
string
default:BRL
​
locale
enum<string>
default:pt-BR
Available options:
pt-BR,
en-US,
es-ES
​
items
object[]
​
paymentMethods
object
​
splits
object[] | null
​
branding
object
​
subscription
object
​
requiredFields
enum<string>[] | null
Available options:
email,
document,
phone,
address
​
customFields
object[] | null
​
successUrl
string<uri> | null
Maximum string length: 2000
​
cancelUrl
string<uri> | null
Maximum string length: 2000
​
metadata
object
​
expirationMinutes
integer | null
Required range: 5 <= x <= 43200

Response

Link atualizado