Skip to main content
GET
Consultar link de pagamento

Authorizations

Authorization
string
header
required

Chave criada no painel em Configurações → Chaves de API → Nova chave → API de pagamentos (dash.velan.app/dashboard/settings/api-keys).

Path Parameters

id
string
required

Identificador do link (id devolvido na criação).

Response

Link.

object
any
id
string
livemode
boolean

false para links criados com chave de teste.

status
enum<string>
Available options:
active,
paid,
expired,
canceled
type
enum<string>
Available options:
offer,
plan
offer_code
string | null
plan_code
string | null
url
string<uri>
short_url
string<uri>
customer
object
external_reference
string | null
metadata
object
coupon_code
string | null
single_use
boolean
expires_at
string<date-time> | null
paid_at
string<date-time> | null
canceled_at
string<date-time> | null
created_at
string<date-time>
order
object | null