Pular para o conteúdo principal
GET
/
v1
/
transactions
Listar transacoes
curl --request GET \
  --url https://api-payment.safefypay.com.br/v1/transactions \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "externalId": "pedido_12345",
        "method": "Pix",
        "amount": 10000,
        "fee": 150,
        "netAmount": 9850,
        "currency": "BRL",
        "status": "Completed",
        "description": "Pagamento do pedido #12345",
        "environment": "Sandbox",
        "expiresAt": "2025-01-15T15:30:00Z",
        "completedAt": "2025-01-15T15:10:00Z",
        "createdAt": "2025-01-15T15:00:00Z",
        "customerId": "550e8400-e29b-41d4-a716-446655440000",
        "customer": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "Joao Silva",
          "email": "joao@email.com",
          "document": "123.456.789-00"
        }
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  },
  "message": null,
  "error": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.safefypay.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Retorna uma lista paginada de transações com opções de filtragem.

Autorizações

Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Parâmetros de consulta

page
integer
padrão:1

Numero da pagina

Exemplo:

1

pageSize
integer
padrão:20

Itens por pagina (max: 100)

Exemplo:

20

status
enum<string>

Filtrar por status

Opções disponíveis:
Pending,
Completed,
Expired,
Failed,
Refunded
Exemplo:

"Completed"

method
enum<string>

Filtrar por metodo de pagamento

Opções disponíveis:
Pix,
CreditCard,
Boleto
Exemplo:

"Pix"

externalId
string

Buscar por ID externo

Exemplo:

"pedido_12345"

customerId
string<uuid>

Filtrar por ID do cliente

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

startDate
string<date-time>

Data inicial (ISO 8601)

Exemplo:

"2025-01-01T00:00:00Z"

endDate
string<date-time>

Data final (ISO 8601)

Exemplo:

"2025-01-31T23:59:59Z"

Resposta

Lista de transacoes

data
object
message
string | null
error
object