Skip to main content
GET
/
v1
/
transactions
Listar transações
curl --request GET \
  --url https://api.ephra.io/v1/transactions \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "clxabc123def456",
      "paymentMethod": "pix",
      "amount": 10000,
      "netAmount": 9850,
      "fees": 150,
      "status": "paid",
      "description": "<string>",
      "createdAt": "2026-06-03T12:00:00.000Z",
      "updatedAt": "2026-06-03T12:01:30.000Z",
      "aprovedAt": "2026-06-03T12:01:30.000Z",
      "refuseReason": "<string>",
      "customer": {
        "id": "<string>",
        "name": "Maria Silva",
        "phone": "<string>",
        "documentType": "cpf",
        "document": "12345678909",
        "emails": [
          {
            "email": "jsmith@example.com"
          }
        ]
      },
      "Pix": {
        "key": "<string>",
        "endToEndId": "<string>",
        "payerInfo": {}
      }
    }
  ],
  "totalRows": 42
}
Retorna uma lista paginada de transações da sua empresa, com filtros opcionais por status, método, cliente e período. Use offset para paginar.

Authorizations

Authorization
string
header
required

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

Query Parameters

offset
string
default:0

Deslocamento para paginação

status
string

Filtra por status (ex.: paid, pending, refused)

paymentMethod
enum<string>
Available options:
pix,
credit_card,
boleto
transactionId
string
email
string
phone
string
document
string

CPF/CNPJ do cliente

name
string
initialDate
string

YYYY-MM-DD

finalDate
string

YYYY-MM-DD

Response

Lista de transações

success
boolean
Example:

true

data
object[]
totalRows
integer
Example:

42