LoyaltyBalance

Cancel transaction

Cancels 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
amountdouble or null
The transaction amount.
balanceDefinitionIdstring or null

Unique identifier (UUID) of the associated balance definition.

cancelledAtstring or null

Timestamp when the transaction was canceled (nullable).

completedAtstring or null

Timestamp when the transaction was completed (nullable).

contactIdinteger or null
Unique identifier of the contact associated with the transaction.
createdAtstring or null
Timestamp when the transaction was created.
eventTimestring or null
Optional timestamp indicating when the transaction event occurred.
expirationDatestring or null

Expiry date of the transaction (nullable).

idstring or null

Unique identifier (UUID) of the transaction.

loyaltyProgramIdstring or null

Unique identifier (UUID) of the associated loyalty program.

metamap from strings to any or null
Optional metadata associated with the transaction.
rejectReasonstring or null

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

rejectedAtstring or null

Timestamp when the transaction was rejected (nullable).

statusstring or null

The current status of the transaction (e.g., pending, completed, rejected).

updatedAtstring or null
Timestamp when the transaction was last updated.

Errors