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: 1,
        balanceDefinitionId: "balanceDefinitionId",
    });
}
main();

{
  "balanceDefinitionId": "string",
  "contactId": 1,
  "count": 1,
  "loyaltyProgramId": "string",
  "transactionHistory": [
    {
      "amount": 1.1,
      "transactionType": "credit",
      "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

limitintegerOptional1-500

Limit the number of records returned

offsetintegerOptional>=0

Page number to retrieve

sortFieldenumOptionalDefaults to createdAt

Field to sort by

Allowed values:

sortenumOptional

Sort order

Allowed values:

contactIdlongRequired>=1

Contact ID

balanceDefinitionIdstringRequiredformat: "uuid"

Balance Definition ID

statusenumOptional

Transaction status filter

Allowed values:

transactionTypeenumOptional

Transaction type filter

Allowed values:

loyaltySubscriptionIdstringOptional

Loyalty Subscription ID filter

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