Docs
Abrir o painel

Consultar link

GET
/links/{id}

Retorna os dados e o status atual de um link. Rota pública: não exige credenciais, é a mesma que o checkout usa para montar a página de pagamento.

Parâmetros de caminho

id*string

id do link, devolvido na criação.

Formatuuid

Parâmetros de query

payment?string

ID de um pagamento pendente, para trazer os dados dele em pending_info.

Corpo da resposta

Link encontrado.

application/json
  1. response
id?string
Formatuuid
url?string
Formaturi
description?string
amount?string

Presente só em links com valor fixo.

currency?string
expiration?integer

Presente só em links com valor fixo.

status?LinkStatus
  • created: disponível para pagamento
  • pending: há um pagamento em andamento
  • processing / paid: pagamento recebido
  • used: link de uso único já pago
  • expired: passou da expiration
Value in"created""pending""processing""paid""used""expired"
single_use?boolean
external_ref?string
back_url?string
logo_url?string
available_methods?array<>
fee_mode?FeeMode

Quem paga a taxa do cartão: customer_pays repassa ao pagador, merchant_absorbs desconta do valor recebido.

Default"customer_pays"
Value in"customer_pays""merchant_absorbs"
max_installments?integer
client_info?

Recebedor do pagamento.

metadata?

Dados para pré-preencher o checkout. Todos opcionais.

pending_info?

Presente quando status é pending.

Exemplo de requisição
curl -X GET 'https://sandbox.xpayz.us/payment-link/links/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Exemplo de resposta
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "url": "http://example.com",  "description": "string",  "amount": "string",  "currency": "string",  "expiration": 0,  "status": "created",  "single_use": true,  "external_ref": "string",  "back_url": "string",  "logo_url": "string",  "available_methods": [    "pix"  ],  "fee_mode": "customer_pays",  "max_installments": 0,  "client_info": {    "name": "string",    "nickname": "string",    "document": "string"  },  "metadata": {    "name": "string",    "document": "string",    "email": "user@example.com",    "phone": "string",    "street": "string",    "number": "string",    "complement": "string",    "neighborhood": "string",    "city": "string",    "state": "string",    "country": "string",    "zip_code": "string"  },  "pending_info": {    "payment_id": "string",    "payment_method": "pix",    "payment_qrcode": "string",    "payment_content": "string",    "payment_expires_at": 0  }}