Skip to main content
GET
/
api
/
v1
/
payments
List payments
curl --request GET \
  --url http://localhost:7701/api/v1/payments \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {}
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 120,
    "last_page": 8
  }
}

Authorizations

​
X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Query Parameters

​
start_date
string<date>
Example:

"2026-01-01"

​
end_date
string<date>
Example:

"2026-12-31"

​
status
enum<string>
Available options:
pending,
approved,
failed,
refunded
​
gateway
string
Example:

"pagarme"

​
payment_method
enum<string>
Available options:
pix,
card,
billet
​
amount_from
integer
Example:

1000

​
amount_to
integer
Example:

50000

​
transaction_id
string
Example:

"abc123"

​
customer_email
string<email>
Example:

"customer@email.com"

​
customer_document
string
Example:

"12345678900"

​
card_brand
string
Example:

"visa"

​
card_last_4
string
Example:

"4242"

​
transaction_type
enum<string>
Available options:
payment,
withdraw
​
per_page
integer
Example:

15

​
page
integer
Example:

1

Response

Paginated list of payments

​
data
object[]
​
meta
object