Complete transaction | Brevo API Documentation

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

{
  "id": "string",
  "amount": 1.1,
  "transactionType": "credit",
  "meta": {},
  "status": "pending",
  "loyaltyProgramId": "string",
  "balanceDefinitionId": "string",
  "contactId": 1,
  "eventTime": "2024-01-15T09:30:00Z",
  "rejectReason": "string",
  "rejectedAt": "2024-01-15T09:30:00Z",
  "expirationDate": "2024-01-15T09:30:00Z",
  "completedAt": "2024-01-15T09:30:00Z",
  "cancelledAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Completes transaction

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

tidstringRequiredformat: "uuid"

Transaction Id

Response

Transaction information

idstringformat: "uuid"

Unique identifier (UUID) of the transaction.

amountdouble

The transaction amount.

transactionTypeenum

The type of the transaction.

Allowed values:

metamap from strings to any

Optional metadata associated with the transaction.

statusenum

The current status of the transaction.

Allowed values:

loyaltyProgramIdstringformat: "uuid"

Unique identifier (UUID) of the associated loyalty program.

balanceDefinitionIdstringformat: "uuid"

Unique identifier (UUID) of the associated balance definition.

contactIdlong

Unique identifier of the contact associated with the transaction.

eventTimedatetime

Optional timestamp indicating when the transaction event occurred (ISO 8601 format).

rejectReasonstring

Reason for rejection if the transaction was declined (nullable).

rejectedAtdatetime

Timestamp when the transaction was rejected (nullable).

expirationDatedatetime

Expiry date of the transaction (nullable).

completedAtdatetime

Timestamp when the transaction was completed (nullable).

cancelledAtdatetime

Timestamp when the transaction was canceled (nullable).

createdAtdatetime

Timestamp when the transaction was created.

updatedAtdatetime

Timestamp when the transaction was last updated.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error