List Transactions

Query your company's transactions with pagination and filters. The list always comes from newest to oldest.

GET/api/Transaction/company/transactions

Query Parameters (Optional)

Parameter	Type	Description
`page`	integer	Page number (default: 1)
`pageSize`	integer	Items per page (default: 10, maximum: 200). Values outside 1 to 200 fall back to 50
`term`	string	Free search in: internal id, transactionId, customer name, e-mail and document, endToEndId, providerTxId, PIX key, payer and receiver name and document, postbackUrl and amount
`enStatusTransaction`	string	Filters by status (e.g. Awaiting, Successful, Failure, Refunded)
`enPaymentSystem`	string	Filters by payment method (e.g. Pix)
`startDate`	datetime	Transactions created from this date/time (UTC)
`endDate`	datetime	Transactions created up to this date
`minValue`	number	Minimum amount, in reais
`maxValue`	number	Maximum amount, in reais
`companyId`	string	Optional. With X-API-Key, omit it or send your own company ID; any other ID returns 403

page

integer

Page number (default: 1)

pageSize

integer

Items per page (default: 10, maximum: 200). Values outside 1 to 200 fall back to 50

term

string

Free search in: internal id, transactionId, customer name, e-mail and document, endToEndId, providerTxId, PIX key, payer and receiver name and document, postbackUrl and amount

enStatusTransaction

string

Filters by status (e.g. Awaiting, Successful, Failure, Refunded)

enPaymentSystem

string

Filters by payment method (e.g. Pix)

startDate

datetime

Transactions created from this date/time (UTC)

endDate

datetime

Transactions created up to this date

minValue

number

Minimum amount, in reais

maxValue

number

Maximum amount, in reais

companyId

string

Optional. With X-API-Key, omit it or send your own company ID; any other ID returns 403

The sort parameter is accepted but has no effect on this endpoint: the order is always from the most recent transaction to the oldest.

Success Response (200 OK)

Response

{
  "items": [
    {
      "id": 41394,
      "leadId": "0f4da067-536b-41cd-91ab-488f2475e441",
      "lead": {
        "id": "0f4da067-536b-41cd-91ab-488f2475e441",
        "externalId": "LEAD-1234",
        "name": "Joao Silva",
        "email": "joao@example.com",
        "phone": "11999999999",
        "documentNumber": "12345678900",
        "documentType": "CPF",
        "street": null,
        "streetNumber": null,
        "complement": null,
        "zipCode": null,
        "neighborhood": null,
        "city": null,
        "state": null,
        "country": null
      },
      "companyName": "Your Company",
      "enSubIntegration": "OnlyUp",
      "value": 5.00,
      "installments": 1,
      "transactionId": "6dcf2aee0d6148e1a12b78db78",
      "gatewayPostbackUrl": "https://...",
      "creditAwaiting": 0,
      "totalDeducted": 0.10,
      "enStatusTransaction": "Successful",
      "enPaymentSystem": "Pix",
      "updateDate": "2025-11-27T11:07:15.010000",
      "createdAt": "2025-11-27T11:06:58.120000",
      "items": [],
      "providerPixInPayload": "{... JSON string from the provider ...}",
      "providerEndToEndId": "E22896431202511271407sjUGQflhcVE",
      "providerTxId": "6dcf2aee0d6148e1a12b78db78",
      "providerPixKey": "c32361fa-44de-4be7-815f-0e782a10860c",
      "providerPayerName": "MARIA SILVA SANTOS",
      "providerPayerDocument": "50651470862",
      "providerReceiverName": null,
      "providerReceiverDocument": null,
      "providerAmount": 5.00,
      "providerCreditedAt": "2025-11-27T11:07:14.997603",
      "feeAmount": 0.10,
      "fixedFeeAmount": 0.00,
      "hiddenFeeAmount": 0,
      "reserveAmount": 0,
      "tpvRateAmount": 0,
      "acquirerFeeAmount": 0,
      "spreadTotalAmount": 0,
      "spreadDetails": null
    }
  ],
  "totalCount": 1,
  "page": 1,
  "pageSize": 10,
  "pageCount": 1,
  "paidCount": 1,
  "paidAmount": 5.00,
  "pendingCount": 0,
  "pendingAmount": 0,
  "refundedCount": 0,
  "refundedAmount": 0
}

On this endpoint the amounts (value, providerAmount, fees and totals) are in reais. The status is in enStatusTransaction and uses the names Awaiting, Pending, Successful, Failure, Refunded, Chargeback and Cancelled, among others. The totals (paidCount, paidAmount, pendingCount, pendingAmount, refundedCount and refundedAmount) cover all transactions in the filter, not only the current page.

JavaScript Example

JavaScript

const CLIENT_ID = 'fbd6b0c9e4b8331b77700ca6e17972b5';
const API_KEY = 'your-secret-api-key';
const query = {
  page: 1,
  pageSize: 50,
  enStatusTransaction: 'Successful',
  startDate: '2025-11-01T00:00:00Z',
};
const queryString = Object.entries(query)
  .filter(([, v]) => v !== undefined && v !== null)
  .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`)
  .join('&');
const response = await fetch(
  `https://api.respawnpay.com/api/Transaction/company/transactions?${queryString}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': CLIENT_ID,
      'X-API-Key': API_KEY,
    },
  }
);
const data = await response.json();
console.log('Transactions:', data.items, 'Total:', data.totalCount);

cURL Example

cURL

curl -X GET "https://api.respawnpay.com/api/Transaction/company/transactions?page=1&pageSize=50&enStatusTransaction=Successful" \
  -H "Accept: application/json" \
  -H "X-Client-Id: <CLIENT_ID>" \
  -H "X-API-Key: <API_KEY>"