Get Transaction History API | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.balance.getTransactionHistoryApi("pid", {
        contactId: 0,
        balanceDefinitionId: "balanceDefinitionId",
    });
}
main();

{
  "balanceDefinitionId": "string",
  "contactId": 1,
  "count": 1,
  "loyaltyProgramId": "string",
  "transactionHistory": [
    {
      "amount": 1.1,
      "balanceExpirationDate": "string",
      "cancelledAt": "string",
      "completedAt": "string",
      "createdAt": "string",
      "id": "string",
      "meta": {},
      "rejectReason": "string",
      "rejectedAt": "string",
      "status": "string"
    }
  ]
}

Returns transaction history

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"

Loyalty Program Id

Query parameters

limitintegerOptionalDefaults to 20

Limit the number of records returned

offsetintegerOptionalDefaults to 0

Page number to retrieve

sortFieldenumOptionalDefaults to createdAt

Field to sort by

Allowed values:

sortenumOptionalDefaults to desc

Sort order, either asc or desc

Allowed values:

contactIdintegerRequiredDefaults to 0

Contact ID

balanceDefinitionIdstringRequiredformat: "uuid"

Balance Definition ID

filterslist of stringsOptional

Filters to apply

statusenumOptional

Transaction status filter. Allowed values: draft, completed, rejected, cancelled, expired

Allowed values:

transactionTypeenumOptional

Transaction type filter. Allowed values: credit, debit

Allowed values:

Response

Successful retrieval of transaction history

balanceDefinitionIdstring

Unique identifier of the associated balance definition.

contactIdinteger

Unique identifier of the contact related to the transactions.

countinteger

Total number of transactions in the history.

loyaltyProgramIdstring

Unique identifier of the associated loyalty program.

transactionHistorylist of objects

List of past transactions associated with the balance.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error