Authorize Points Transaction

Beta

POST

https://api.npretail.app/:tenant/:environment/:company/membership/:membershipId/points/reserve

POST

/:tenant/:environment/:company/membership/:membershipId/points/reserve

$ curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./membership/cdef7890-abcd-0123-1234-567890abcdef/points/reserve \
>      -H "x-np-api-key: <NaviPartner API Key>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "requestId": "11aa22bb-33cc-44dd-55ee-66ff77aa88bb",
>   "type": "WITHDRAW",
>   "pointsToReserve": 200,
>   "reason": "Payment in POS sale",
>   "externalReferenceNo": "RCPT-582399102",
>   "externalSystemIdentifier": "BCTenant-POSStore",
>   "timeoutPeriod": 300,
>   "externalSystemUserIdentifier": "SalespersonCode",
>   "externalBusinessUnitIdentifier": "My businesss unit",
>   "tags": [
>     {
>       "key": "SALES-CHANNEL",
>       "value": "WEB"
>     },
>     {
>       "key": "REF-NO",
>       "value": "W23456782"
>     },
>     {
>       "key": "CAMPAIGN",
>       "value": "BLACK FRIDAY"
>     }
>   ]
> }'

200Authorize a point deduction

1 {
2   "authorizationCode": "362FB68C444E41D691FF19EE470B30A1",
3   "expiresAt": "2025-06-23T12:05:00Z"
4 }

Creates an authorization for a points withdrawal or deposit. This reserves the points for a specified period and must be finalized.

Authentication

x-np-api-keystring

API Key authentication via header

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.

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.

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.

tagslist of objectsOptional

Optional metadata tags to store additional context about the transaction (e.g., sales channel, campaign, reference numbers)

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.

Authentication

Path parameters

Headers

Request

Response