WysePayDocs

Listar transações

GET
/api/v1/transactions

As cobranças da conta, da mais nova para a mais antiga, com filtros. Veja Paginação.

Permissão da chave: transactions:read.

Autenticação

headerx-api-key<token>

Sua chave de API, criada no painel em Desenvolvedores → Chaves de API.

Parâmetros de consulta

limit?integer

Quantos itens por página (1 a 100).

Faixa1 <= value <= 100
Padrão20
startingAfter?string

O id do último item da página anterior. A página seguinte começa depois dele.

Tamanholength <= 64
status?string

Só transações com este status.

Tamanholength <= 32
paymentLinkId?string

Só as cobranças geradas por este link.

Tamanholength <= 64
createdFrom?string

Criadas a partir de (ISO 8601).

Formato^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatodate-time
createdTo?string

Criadas antes de (ISO 8601).

Formato^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatodate-time

Corpo da resposta

Uma página de transações.

application/json
  1. response
data*array<>
hasMore*boolean

true quando há mais itens: peça de novo com startingAfter = o id do último.

curl -X GET "https://example.com/api/v1/transactions"
{  "data": [    {      "id": "txn_01k6g8m2v4x7z9b3c5d7f9h0j2",      "status": "WAITING_PAYMENT",      "amountCents": 8990,      "feeCents": 90,      "netAmountCents": 8900,      "description": "Pedido #1042",      "pix": {        "copyPaste": "00020101021226850014br.gov.bcb.pix…6304A1B2",        "qrCode": "00020101021226850014br.gov.bcb.pix…6304A1B2"      },      "customer": {        "id": "cus_01k6g8m2v4x7z9b3c5d7f9h0j2",        "name": "Ana Souza",        "email": "[email protected]",        "phone": "11912345678",        "documentType": "CPF",        "document": "12345678909"      },      "paymentLinkId": "string",      "dispute": {        "id": "string",        "status": "OPEN",        "amountCents": 0,        "createdAt": "2026-10-04T15:30:00.000Z"      },      "metadata": {        "orderId": "1042"      },      "livemode": true,      "expiresAt": "2026-10-04T15:30:00.000Z",      "paidAt": "2026-10-04T15:30:00.000Z",      "createdAt": "2026-10-04T15:30:00.000Z",      "updatedAt": "2026-10-04T15:30:00.000Z"    }  ],  "hasMore": true}

Gerar uma cobrança Pix POST

Cria a cobrança e devolve o código Pix (copia e cola e QR Code). O status começa em `WAITING_PAYMENT`; quando o cliente pagar, chega o webhook `transaction.paid`. Permissão da chave: `charges:write`.

Consultar uma transação GET

A situação atual da cobrança. Um Pix vencido sem pagamento aparece como `EXPIRED`. Permissão da chave: `transactions:read`.