LoyaltyBalance

Complete transaction

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

Unique identifier (UUID) of the associated balance definition.

cancelledAtstring

Timestamp when the transaction was canceled (nullable).

completedAtstring

Timestamp when the transaction was completed (nullable).

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

Expiry date of the transaction (nullable).

idstring

Unique identifier (UUID) of the transaction.

loyaltyProgramIdstring

Unique identifier (UUID) of the associated loyalty program.

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

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

rejectedAtstring

Timestamp when the transaction was rejected (nullable).

statusstring

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

updatedAtstring
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