List Payments

💡 Retrieves the list of card payment transactions.

Making Request

The call must be made using the GET method. Authentication via Authorization header is required.

GET/v1/card_payments

Request Parameters (Query Params)

Attribute	Type	Description	Required	Default
per_page	integer	Number of records per page	No	10
current_page	integer	Current page	No	1
search	string	Filter by transaction identifiers: muid, rrn, tracking_number, card_holder_name	No	—
status	string	Filter by transaction status (transaction_status). Accepted values: pending, pre_authorized, authorized, denied, canceled, expired	No	—
payment_type	string	Filter by payment type. Accepted values: credit, debit, prepaid	No	—
active	boolean	Filter by active or inactive transactions (true or false)	No	—
begin_created_at	string	Initial creation date of the record (ISO 8601 format)	No	—
end_created_at	string	Final creation date of the record (ISO 8601 format)	No	—
external_id	string	Unique identifier generated by the client	No	-
refund_tracking_number	string	Unique identifier generated by the client to identify transactions with D+N refunds	No	-
platform_name	string	Platform name generating the checkout	No	-
billing_url	string	URL to redirect the user to the customized billing page	No	-
return_url	string	Webhook URL where notifications will be sent	No	-

Request Example

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

Success

HTTP 200 Response Body - Example

{
  "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"
}

Important Response Fields

Attribute	Type	Description
total_pages	integer	Number of pages
total_count	integer	Total number of records
current_page	integer	Filter by transaction identifiers: muid, rrn, tracking_number, card_holder_name
muid	string	Unique transaction identifier, used to perform queries for a specific transaction

Important Notes

• The begin_created_at and end_created_at fields must be sent in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).
• The response will always contain pagination information in pagination_info.
• The status field at the root level ("status": "ok") indicates the request status and should not be confused with the transaction status.