Complete transaction

POST

https://api.brevo.com/v3/loyalty/balance/programs/:pid/transactions/:tid/complete

POST

/v3/loyalty/balance/programs/:pid/transactions/:tid/complete

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

{
  "id": "string",
  "amount": 1.1,
  "balance": 1.1,
  "transactionType": "credit",
  "meta": {},
  "status": "draft",
  "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

idstringOptionalformat: "uuid"

Unique identifier (UUID) of the transaction.

amountfloatOptional

The transaction amount.

balancefloatOptional

The contact’s total balance for this balance definition after the transaction was applied. Only returned when the transaction actually updated the balance (i.e. it was completed or auto-completed).

transactionTypeenumOptional

The type of the transaction.

metamap from strings to anyOptional

Optional metadata associated with the transaction.

statusenumOptional

The current status of the transaction.

loyaltyProgramIdstringOptionalformat: "uuid"

Unique identifier (UUID) of the associated loyalty program.

balanceDefinitionIdstringOptionalformat: "uuid"

Unique identifier (UUID) of the associated balance definition.

contactIdlongOptional

Unique identifier of the contact associated with the transaction.

eventTimedatetimeOptional

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

rejectReasonstringOptional

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

rejectedAtdatetimeOptional

Timestamp when the transaction was rejected (nullable).

expirationDatedatetimeOptional

Expiry date of the transaction (nullable).

completedAtdatetimeOptional

Timestamp when the transaction was completed (nullable).

cancelledAtdatetimeOptional

Timestamp when the transaction was canceled (nullable).

createdAtdatetimeOptional

Timestamp when the transaction was created.

updatedAtdatetimeOptional

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