API Reference
HomeAPI ReferenceGuidesChangelogKarhoo.com

Burn loyalty points

post
https://your.hostname.com/loyalty/users//burn

Karhoo will call this endpoint in order to burn loyalty points for a specific user. For example if the value of a trip is 37 EUR and the user chooses to use 1500 loyalty points (with a value of 15 EUR at a 1EUR=100points exchange rate) you will receive a request for 1500 points which will specify also the currency equivalent and the exchange rate version that was used for the operation.

Path Params
string
required

The id of the user in your system.

Body Params

request body

uuid
required

The ID of the trip which the traveller is burning points

number
required

The number of loyalty points available to burn for this user

string
required

Currency value equivalent to the burned points

string
required

The ISO 4217 code for currency used.

string
required

The version returned in GET /loyalty/exchange_rates that was used to calculate the conversion rate to points

string
required

Human readable description of the transaction

uuid
required

The iID of the transaction on Karhoo side. You will never receive two requests with the same karhoo_transaction_id so it can be used to ensure the request is idempotent

Responses

Updated about 6 years ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json
Updated about 6 years ago