Docs
Abrir o painel

Listar pagamentos do link

GET
/links/{id}/payments

Lista os pagamentos feitos em um link, do mais recente para o mais antigo.

Autorização

SecretIDSecretKey
headerX-Secret-ID<token>

ID da credencial de API, gerado no painel.

headerX-Secret-Key<token>

Chave secreta da credencial. Nunca exponha no front-end.

Parâmetros de caminho

id*string

id do link, devolvido na criação.

Formatuuid

Parâmetros de query

page?integer
Range1 <= value
Default1
per_page?integer
Default10
status?string
Value in"pending""processing""done""cancelled""rejected""expired""refund_requested""refunded"
method?string
Value in"pix""credit_card""xpayz""token"
amount?string
payer_name?string
payer_email?string
correlation_id?string

Corpo da resposta

Página de pagamentos.

application/json
  1. response
page?integer
pages?integer
total?integer
data?
Exemplo de requisição
curl -X GET 'https://sandbox.xpayz.us/payment-link/links/497f6eca-6276-4993-bfeb-53cbbbba6f08/payments'
Exemplo de resposta
{  "page": 0,  "pages": 0,  "total": 0,  "data": {    "payments": [      {        "id": "string",        "status": "pending",        "method": "pix",        "currency": "string",        "amount": "string",        "expected_amount": "string",        "fee": "string",        "net_amount": "string",        "symbol": "string",        "payer_name": "string",        "payer_email": "string",        "payer_document": "string",        "payer_type": "customer",        "paid_at": "2019-08-24T14:15:22Z",        "expires_at": 0      }    ],    "total": "string"  }}