Sign in

Transaction Settlement

POST https://{organization}.myguper.com/api/loyalty/transactionSettlement/{TID}

Settles a transaction by TID — finalises pending accumulation and redemption so balances become available to the customer.

This is the explicit way to finalize a transaction that was confirmed with waitSettlement: true (see Confirm Order by confirmToken): it credits the rewards and settles the reservation. A held transaction is also finalized automatically when its order reaches a final state — completed (rewards credited) or canceled (reservation released and any pending reward rolled back) — so calling this endpoint is only required when you drive settlement yourself instead of relying on the order flow.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header. Endpoints that support a Public mode (e.g. acúmulo and resgate previews) accept the same request without the header — Private mode adds customer data and a confirmation token to the response.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper. Omit only on endpoints that explicitly support a Public mode.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Path parameters

Name Type Description
TID * string Transaction identifier (TID) of the held transaction to settle.

Responses

Copied to clipboard