Skip to main content
GET
/
payments
cURL
curl --request GET \
  --url https://sandbox-api.superpagamentos.com/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "5a2245d8-2e5c-4969-ad70-b38a6a8aec0d",
      "status": "PENDING",
      "paymentMethod": "billet",
      "currency": "BRL",
      "amount": 9999,
      "postbackUrl": "https://api.exemplo.com/webhook",
      "createdAt": "2025-06-12T03:36:12.977Z",
      "updatedAt": "2025-06-12T03:36:12.977Z",
      "splits": [],
      "buyerDetails": {
        "firstName": "Maria",
        "lastName": "Silva",
        "email": "maria.silva@exemplo.com",
        "document": "12345678900",
        "phone": "11999999999",
        "street": "Avenida Paulista",
        "streetNumber": 1000,
        "neighborhood": "Bela Vista",
        "complement": "Sala 123",
        "reference": "Próximo ao metrô",
        "city": "São Paulo",
        "state": "SP"
      },
      "billetDetails": {
        "barcode": "23793391009000541473681000807503211100000009999",
        "digitableLine": "23793391009000541473681000807503211100000009999",
        "expirationDate": "2025-06-12T00:00:00+00:00",
        "pdfUrl": "https://api.exemplo.com/boletos/123456",
        "interestAmount": 9999,
        "interestPercentage": "0",
        "interestStartDate": "2025-06-13",
        "interestType": "DAILY_AMOUNT",
        "lateFeeAmount": 99,
        "lateFeePercentage": "0",
        "lateFeeStartDate": "2025-06-13",
        "lateFeeType": "FIXED",
        "paymentLimitDate": "2025-06-12T00:00:00+00:00"
      }
    },
    {
      "id": "0b64746e-d77b-4ff4-8b9d-272b7e5cbbb3",
      "status": "SUCCEEDED",
      "paymentMethod": "card",
      "currency": "BRL",
      "amount": 10000,
      "postbackUrl": "",
      "createdAt": "2025-06-09T20:59:45.597Z",
      "updatedAt": "2025-06-09T20:59:45.597Z",
      "splits": [],
      "installments": 10,
      "buyerDetails": {
        "firstName": "João",
        "lastName": "Santos",
        "email": "joao.santos@exemplo.com",
        "document": "98765432100",
        "phone": "11988888888",
        "street": "Rua Augusta",
        "streetNumber": 500,
        "neighborhood": "Consolação",
        "complement": "Apto 45",
        "reference": "Edifício Comercial",
        "city": "São Paulo",
        "state": "SP"
      },
      "cardDetails": {
        "brand": "Mastercard",
        "first4Digits": "5555",
        "last4Digits": "1234",
        "expirationMonth": "12",
        "expirationYear": "2025"
      }
    }
  ],
  "meta": {
    "total": 17,
    "page": 1,
    "limit": 10,
    "totalPages": 2
  },
  "message": null
}

Authorizations

​
Authorization
string
header
required

Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer <token>

Query Parameters

​
page
integer
default:1

Número da página para paginação

​
limit
integer
default:10

Quantidade de itens por página

​
status
enum<string>

Filtro por status da transação

Available options:
PENDING,
SUCCEEDED,
FAILED,
CREATED,
REVERSED,
CANCELED,
PRE_AUTHORIZED,
DISPUTED,
CHARGEBACK,
PAID,
REFUNDED
​
paymentMethod
enum<string>

Filtro por método de pagamento

Available options:
pix,
card,
billet
​
amount
number

Filtro por valor da transação

​
customerId
string

Filtro por ID do cliente

​
subscriptionId
string

Filtro por ID da assinatura

Response

200 - application/json

Lista de transações retornada com sucesso

​
data
any[]
​
meta
object
​
message
string | null