Skip to main content
PATCH
Atualizar link de pagamento

Authorizations

Authorization
string
header
required

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

Path Parameters

id
string<uuid>
required

ID do link (UUID)

Body

application/json
submerchant_id
string<uuid>

ID do submerchant

title
string
Required string length: 3 - 255
description
string
Maximum string length: 1000
amount
integer
Required range: x >= 1
currency
string
Required string length: 3
product_type
enum<string>
Available options:
physical,
digital
allowed_payment_methods
enum<string>[]
Minimum array length: 1
Available options:
credit_card,
debit_card,
pix,
boleto
max_installments
integer
Required range: 1 <= x <= 24
expires_at
string<date-time>
max_uses
integer
Required range: x >= 1
status
enum<string>
Available options:
active,
inactive
metadata
object
redirect_url
string<uri>

URL para redirecionar o comprador apos o pagamento ser confirmado

Maximum string length: 2048
primary_color
string

Cor primária do checkout em hexadecimal (ex: #FF5733)

summary_panel_color
string

Cor do painel de resumo em hexadecimal

merchant_logo_url
string<uri>

URL do logo do merchant no checkout

Response

Link atualizado com sucesso

success
boolean
Example:

true

message
string
data
object