List transactions by PIX key

GET /api/pix/transactions/pix-key/{pixKey}

GET https://api.fypay.me/api/pix/transactions/pix-key/{pixKey}

Requires a Bearer token in the Authorization header. See Generate Token to obtain one.

Returns transactions associated with a specific PIX key with pagination.

Features:

Amounts converted to BRL (2 decimal places)
Status and types mapped to display labels
Counterparty documents are masked
Maximum interval of 31 days between startDate and endDate
Default startDate: last 30 days
Maximum limit of 1000 total results

Authentication

Requires a Bearer token in the Authorization header.

Path Parameters

Parameter	Type	Required	Description
`pixKey`	string	Yes	PIX key (CPF, CNPJ, phone, email, or random EVP key)

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number (1-indexed). Default: 1
`size`	integer	No	Number of records per page (max 1000). Default: 20
`status`	string	No	Filter by status: `PENDING`, `CONFIRMED`, `ERROR`
`type`	string	No	Filter by type: `PAYMENT`, `WITHDRAW`, `REFUND_IN`, `REFUND_OUT`
`startDate`	string	No	Start date (ISO 8601). Default: last 30 days
`endDate`	string	No	End date (ISO 8601). Default: current date

Code Examples

cURL

curl -X GET "https://api.fypay.me/api/pix/transactions/pix-key/12345678901" \
  -H "Authorization: Bearer $FYPAY_TOKEN"

const axios = require('axios');

const response = await axios.get('https://api.fypay.me/api/pix/transactions/pix-key/12345678901', {
  headers: { 'Authorization': `Bearer ${process.env.FYPAY_TOKEN}` },
});
console.log(response.data);

import os, requests

response = requests.get(
    'https://api.fypay.me/api/pix/transactions/pix-key/12345678901',
    headers={'Authorization': f'Bearer {os.environ["FYPAY_TOKEN"]}'},
)
print(response.json())

$ch = curl_init('https://api.fypay.me/api/pix/transactions/pix-key/12345678901');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('FYPAY_TOKEN'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.fypay.me/api/pix/transactions/pix-key/12345678901"))
    .header("Authorization", "Bearer " + System.getenv("FYPAY_TOKEN"))
    .GET()
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response (200)

{
  "data": [
    {
      "transactionId": "12345",
      "externalId": "ext-123456",
      "status": "Confirmado",
      "operationType": "Pix in",
      "movementType": "CREDIT",
      "originalAmount": 100.00,
      "feeAmount": 1.00,
      "finalAmount": 99.00,
      "amountPaid": 100.00,
      "mismatchAmount": null,
      "endToEndId": "E12345678901234567890123456789012",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "processedAt": "2025-01-15T10:30:05.000Z",
      "counterpart": {
        "name": "João Silva",
        "document": "***.456.789-**",
        "bank": {
          "bankISPB": "00000000",
          "bankName": "Banco do Brasil",
          "bankCode": "001",
          "accountBranch": "0001",
          "accountNumber": "123456-7"
        }
      }
    }
  ],
  "metadata": {
    "page": 1,
    "size": 20,
    "total": 150,
    "totalPages": 8,
    "hasNext": true,
    "hasPrevious": false
  }
}

originalAmount holds the amount actually paid (before confirmation, the amount charged). amountPaid is null until confirmation, and mismatchAmount holds the difference between charged and paid (null when there is no mismatch; positive = underpaid, negative = overpaid).

Errors

Status	Description
400	Invalid parameters or date range exceeds 31 days
401	Missing or invalid token