Skip to main content
GET
GET /payment-link/{id} retorna um dos seus links de pagamento. Consulte-o para saber se um link foi pago: status é active, used, expired ou cancelled, e usesCount é a quantidade de pagamentos bem-sucedidos recebidos por ele. Um link que pertence a outro lojista, ou ao outro ambiente, retorna 404.

Exemplo

Pagamentos feitos por um link são pagamentos comuns: eles disparam os webhooks de pagamento habituais, e a reference do link é o orderCode deles.

Autorizações

Authorization
string
header
obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parâmetros de caminho

id
string<uuid>
obrigatório

The payment link id.

Parâmetros de consulta

merchantCode
string

Your merchant account identifier. Required if the key maps to more than one merchant account.

Resposta

The payment link

id
string<uuid>
url
string<uri>

The hosted checkout URL to share with the payer.

type
enum<string>
Opções disponíveis:
one-time,
subscription
status
enum<string>

used once a single-use link takes its first successful payment, or a reusable link reaches maxUses.

Opções disponíveis:
active,
used,
expired,
cancelled
amountMode
enum<string>
Opções disponíveis:
fixed,
customer_entered
amount
object

Absent on subscription links. For customer_entered links only currency and exponent are set.

amountMin
integer<int64>

Minimum payer-entered amount, minor units.

amountMax
integer<int64>

Maximum payer-entered amount, minor units.

subscriptionPlanId
integer<int64>
checkoutConfigId
string<uuid>
title
string
description
string
reference
string
customerEmail
string
customerName
string
returnUrl
string<uri>
saveCardEnabled
boolean
reusable
boolean
maxUses
integer
usesCount
integer

Number of successful payments taken through this link.

environment
enum<string>
Opções disponíveis:
production,
sandbox
expiresAt
string<date-time>
usedAt
string<date-time>
createdAt
string<date-time>