Home
API Reference

Create Points Scheme

post
https://resources.uk.eagleeye.com/schemes/points

This method allows the calling application to create a Scheme.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

OK.

string
enum

The type of Scheme this is. These types are configured as part of implementation with a client.

Allowed:
string
enum

The class of this Scheme.

Allowed:
integer

The version number of this Scheme that is automatically generated.

string | null

An external reference for this Scheme, unique to each client.

string
enum

The status of the Scheme.

details
object

The details of the Scheme.

rules
object

Scheme Rules. (Not implemented for Schemes)

relationships
object | null

Specify if this Scheme has any other related Schemes. The key of the object is relationship type of either AGGREGATE_CHILD, AGGREGATE_CHILD_OF.

services
object | null

How fund balances are effected when each transaction type occurs.

rates
object

Redemption & earn rates for the Scheme.

string | null

The default client type for an Account unless otherwise stated during individual Account creation. The list of available options for this field are defined during client onboarding. (Not implemented for Schemes)

autoReduce
object
pointsLimitPerPeriod
array of objects | null

Rules for limiting points rewarded against a points account per defined period.

pointsLimitPerPeriod
negativeBalance
object

Enable if accounts related to this scheme can go into a negative balance.

custom
object | null

It contains objects of custom form json values.

integer | null

Override value the length of time that points will be locked for before automatically being released.

pendingPoints
object | null

Rules for Pending Points.

tiers
object | null
earnTransactionLimit
object | null

Rules for Earn Transaction Limit.

rewardBank
object | null

Configuration options related to Reward Banks for the Scheme.

Headers
string
required

Client ID, This will be provided by EES and is unique to the company calling the API.

string
required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret.

string
enum

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

Allowed:
string

Unique Reference for the API transaction within the calling company.

string

This flag denotes the number of attempts that have been made for this request.

Responses

Updated 26 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 26 days ago