Authorize Points Transaction
BetaPOST
https://api.npretail.app/:tenant/:environment/:company/membership/:membershipId/points/reserve
Creates an authorization for a points withdrawal or deposit. This reserves the points for a specified period and must be finalized.
Path parameters
tenantstringRequired
Your Entra Tenant ID. More details.
environmentstringRequired
Your Business Central Environment. More details.
companystringRequired
Your Business Central Company. More details.
membershipIdUUIDRequired
Unique identifier for a membership.
Headers
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-api-versiondateOptional
Used for API versioning. More details.
Request
This endpoint expects an object.
requestIdUUIDRequired
A unique identifier for the request. If you send the same requestId twice, it will be guaranteed to only trigger once.
typeenumRequired
The type of the request.
Allowed values:
pointsToReserveintegerRequired
The positive number of points to reserve. Set type to withdrawal to deduct points.
reasonstringRequired
A description of why the points are being reserved.
externalReferenceNostringRequired
Your external reference number, such as a POS Receipt number, invoice number etc.
externalSystemIdentifierstringRequired
An identifier of your external system. This together with the entra app name identifies the external system that is making the operation.
timeoutPeriodintegerOptional
The duration in minutes for which the authorization is valid.
externalSystemUserIdentifierstringOptional
An identifier for the user in the external system, e.g. a POS UnitId, a salesperson code in an external POS or a user ID in a customer support tool.
externalBusinessUnitIdentifierstringOptional
An identifier for the business unit of the external system.
Response
This endpoint returns an object.
authorizationCodestring
A unique identifier for a points transaction to be used for Finalize or Cancel the points transaction. Will not be returned if autoFinalize is set to true.
expiresAtdatetime
The date and time when the authorization expires if a timeoutPeriod is specified in the request.