Listar pagamentos

💡 Recupera a lista de transações de pagamento com cartão.

Fazendo Requisição

A chamada deverá ser feita utilizando o método GET. É necessária a autenticação via Authorization header.

GET/v1/card_payments

Parâmetros da Requisição (Query Params)

Atributo	Tipo	Descrição	Obrigatório	Default
per_page	integer	Quantidade de registros por página	Não	10
current_page	integer	Página atual	Não	1
search	string	Filtra por identificadores da transação: muid, rrn, tracking_number, card_holder_name	Não	—
status	string	Filtra por status da transação(transaction_status). Valores aceitos: pending, pre_authorized, authorized, denied, canceled, expired	Não	—
payment_type	string	Filtra por tipo de pagamento. Valores aceitos: credit, debit, prepaid	Não	—
active	boolean	Filtra por transações ativas ou inativas (true ou false)	Não	—
begin_created_at	string	Data inicial de criação do registro (formato ISO 8601)	Não	—
end_created_at	string	Data final de criação do registro (formato ISO 8601)	Não	—
external_id	string	Identificador único gerado pelo cliente	Não	—
refund_tracking_number	string	Identificador único gerado pelo cliente para identificar transações com devoluções D+N	Não	—
platform_name	string	Nome da plataforma que está gerando o checkout	Não	—
billing_url	string	URL para redirecionar o usuário para a página customizada de cobrança	Não	—
return_url	string	URL do webhook onde as notificações serão enviadas	Não	—

Exemplo de Requisição

GET /v1/card_payments?active=true&search=1c60913e2bfe419da4ed6a27a5d4186f

Sucesso

HTTP 200 Response Body - Exemplo

{
  "card_payments": [
    {
      "muid": "1c60913e2bfe419da4ed6a27a5d4186f",
      "external_id": "string",
      "amount": 12,
      "currency": "BRL",
      "status": "accepted",
      "last_digits": "6669",
      "installments": 1,
      "card_holder_name": "WALTER M C ALVES",
      "payment_type": "credit",
      "active": true,
      "transaction_status": "pending",
      "transaction_method": "cnp",
      "refund_transaction_number": "string",
      "platform_name": "string",
      "billing_url": "string",
      "return_url": "string",
      "created_at": "2025-09-11T19:12:56Z"
    }
  ],
  "pagination_info": {
    "total_pages": 1,
    "total_count": 1,
    "current_page": 1
  },
  "status": "ok"
}

Campos importantes do Response

Atributo	Tipo	Descrição
total_pages	integer	Quantidade de páginas
total_count	integer	Quantidade de registros totais
current_page	interger	Filtra por identificadores da transação: muid, rrn, tracking_number, card_holder_name
muid	string	Identificador único da transação, utilizado para realizar consultas por uma transação específica

Notas Importantes

• Os campos begin_created_at e end_created_at devem ser enviados em formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
• A resposta sempre conterá informações de paginação em pagination_info.
• O campo status no nível raiz ("status": "ok") indica o status da requisição e não deve ser confundido com o status da transação.