LoyaltyBalance

Create balance order

Returns created order

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

Request

Order Payload
amountdoubleRequired

Order amount (must be non-zero).

balanceDefinitionIdstringRequired

Unique identifier (UUID) of the associated balance definition.

contactIdintegerRequired>=1

Unique identifier of the contact placing the order (must be ≥ 1).

dueAtstringRequired
RFC3339 timestamp specifying when the order is due.
sourcestringRequired

Specifies the origin of the order (engine or user).

expiresAtstringOptional
Optional RFC3339 timestamp defining order expiration.
metamap from strings to anyOptional
Optional metadata associated with the order.

Response

Successful creation of order
amountdouble

Order amount (must not be zero).

contactIdinteger>=1

Unique identifier of the contact placing the order (must be ≥ 1).

createdAtstring
RFC3339 timestamp indicating when the order was created.
dueAtstring
RFC3339 timestamp specifying when the order is due in the future.
loyaltyProgramIdstring
Unique identifier of the loyalty program associated with the order.
updatedAtstring
RFC3339 timestamp indicating the last update to the order.
balanceDefinitionIdstring or null

Optional unique identifier (UUID) of the associated balance definition.

expiresAtstring or null
Optional RFC3339 timestamp defining order expiration in the future.
idstring or null
Unique identifier for the balance order.
metamap from strings to any or null
Optional metadata associated with the order.
processedAtstring or null
Optional RFC3339 timestamp indicating when the order was processed.
transactionidstring or null
Optional reference to the associated transaction ID.

Errors