Skip to main content
GET
/
transactions
List all transactions
curl --request GET \
  --url https://api.mercuriumpagamentos.com/transactions \
  --header 'Authorization: Bearer <token>'
{
  "transactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 500,
      "netAmount": 400,
      "status": "PENDING",
      "paymentMethod": "PIX",
      "createdAt": "2023-11-07T05:31:56Z",
      "paidAt": "2023-11-07T05:31:56Z",
      "customer": {
        "name": "João da Silva",
        "email": "jsmith@example.com",
        "phone": "11999999999",
        "document": "12345678909"
      },
      "products": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Wireless Mouse",
          "amount": 500
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 10,
    "totalCount": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
perPage
integer
default:10
Required range: 1 <= x <= 100
​
status
enum<string>
Available options:
PENDING,
PAID,
FAILED,
REFUNDED
​
startDate
string<date-time>
​
endDate
string<date-time>
​
orderBy
enum<string>
default:createdAt
Available options:
createdAt,
amount
​
orderDirection
enum<string>
default:desc
Available options:
asc,
desc

Response

​
transactions
object[]
required
​
pagination
object
required