WysePayDocs

Consultar uma transação

GET
/api/v1/transactions/{id}

A situação atual da cobrança. Um Pix vencido sem pagamento aparece como EXPIRED.

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 da URL

id*string

O id da transação (txn_…).

Corpo da resposta

A transação.

application/json
  1. response

Uma cobrança Pix.

id*string
status*string

Situação da cobrança. As mais comuns: WAITING_PAYMENT (Pix gerado, aguardando), PAID (pago) e EXPIRED (venceu sem pagamento).

Valores aceitos"CREATED""WAITING_PAYMENT""PENDING""PROCESSING""AUTHORIZED""PAID""EXPIRED""CANCELLED""FAILED""REFUSED""REFUNDED""DISPUTE""CHARGEDBACK""BLOCKED"
amountCents*integer

Valor cobrado, em centavos.

feeCents*integer

Taxa da WysePay, em centavos.

netAmountCents*integer

O que entra no seu saldo: valor menos a taxa.

description*string
pix*

Dados para o pagador pagar.

customer*|null
paymentLinkId*|

O link de pagamento que gerou esta cobrança, quando houver.

dispute*|

MED (contestação) aberto sobre este pagamento, se houver.

metadata*|

O que você enviou em metadata ao criar a cobrança.

livemode*boolean

false quando criada com uma chave de teste.

expiresAt*|null
paidAt*|null
createdAt*string
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
updatedAt*string
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
curl -X GET "https://example.com/api/v1/transactions/string"
{  "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"}

Listar transações GET

As cobranças da conta, da mais nova para a mais antiga, com filtros. Veja Paginação. Permissão da chave: `transactions:read`.

Criar um link de pagamento POST

Cria um checkout com o valor e a descrição. Envie a `url` ao cliente: ele preenche os dados, paga com Pix e vê o comprovante. Permissão da chave: `payment_links:write`.