API docs by Redocly

Bluai Admin API (1.0.0)

Download OpenAPI specification:

Admin: admin@blue.com Terms of Service

This is full API documentation of BluAi admin API.

Authentication

Refresh auth token

Generate a new authentication token and invalidate the current one

Authorizations:
None
cookie Parameters
refresh_token
required
string
Request Body schema: application/json
required
refresh_token
required
string

Refresh token for local storage on frontend

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Logout

Logout and invalidate the current authentication token

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{ }

Send reset password link

Send reset password link to the specified email

Authorizations:
None
Request Body schema: application/json
required
email
required
string

account email identifier

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reset password

Reset the password to a new one by using the token sent via the email link

Authorizations:
None
Request Body schema: application/json
required
token
required
string

token sent via the email link

password
required
string <password>

the new password

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get OAuth Redirect URL

Generates and returns the redirect URL for the specified OAuth provider.

Authorizations:
None
path Parameters
provider
required
string
Value: "microsoft"
Example: microsoft

The OAuth provider to use.

Responses

Response samples

Content type
application/json
{}

Handle OAuth Callback

Handles the callback from the OAuth provider after successful user authentication, and returns access/refresh tokens.

Authorizations:
None
path Parameters
provider
required
string
Value: "microsoft"
Example: microsoft

The OAuth provider that handled the authentication.

query Parameters
code
required
string

The authorization code returned by the provider.

state
required
string

The state parameter for CSRF protection.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get flow by token

Sometimes you may need to get flow by access token

Authorizations:
bearer
header Parameters
X-Flow-Token
string

Responses

Response samples

Content type
application/json
{
  • "flow": {
    }
}

Create admin auth flow

Creates new admin auth flow with access token which can be used to go over flow's steps

Authorizations:
None
Request Body schema: application/json
required
login
required
string

admin account login identifier

password
required
string <password>

password

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "flow_token": "7364598720736459872073645987207364598720",
  • "flow": {
    }
}

Complete admin auth flow

Authenticate admin after passing admin auth flow

Authorizations:
None
header Parameters
X-Flow-Token
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Choose auth method

Choose auth method between Google 2FA or email OTP as a flow step

Authorizations:
None
header Parameters
X-Flow-Token
string
Request Body schema: application/json
required
method
required
integer

1 - Google 2FA, 2 - OTP

Responses

Request samples

Content type
application/json
{
  • "method": 0
}

Response samples

Content type
application/json
{
  • "flow_token": "7364598720736459872073645987207364598720",
  • "flow": {
    }
}

Get Google 2FA code

Get Google 2FA code in form of QR code and text secret

Authorizations:
None
header Parameters
X-Flow-Token
string

Responses

Response samples

Content type
application/json
{
  • "text_code": "string",
  • "qr_code": "string"
}

Provide 2FA code

Provide verification TOTP code from authenticator app

Authorizations:
None
header Parameters
X-Flow-Token
string
Request Body schema: application/json
required
code
required
string

TOTP code from authenticator app

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "flow_token": "7364598720736459872073645987207364598720",
  • "flow": {
    }
}

Send OTP to mobile

Send OTP(One Time Password) to mobile. First endpoint for "otp" flow step type

Authorizations:
None
header Parameters
X-Flow-Token
string

Responses

Response samples

Content type
application/json
{
  • "otp_token": "string",
  • "otp_attempts": "string",
  • "otp_token_expired_in_sec": "string",
  • "otp_template": "login"
}

Verify OTP

Verify OTP(One Time Password). You should use otp_token provided by send otp action. Second endpoint for "otp" flow step type

Authorizations:
None
header Parameters
X-Flow-Token
string
Request Body schema: application/json
required
otp_token
required
string

Otp token provided by send otp action

otp_value
string

Responses

Request samples

Content type
application/json
{
  • "otp_token": "string",
  • "otp_value": "string"
}

Response samples

Content type
application/json
{
  • "flow_token": "7364598720736459872073645987207364598720",
  • "flow": {
    }
}

Reset auth method

reset_auth_method

Authorizations:
bearer
path Parameters
admin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Send reset password link by admin id

Send reset password link to the specified admin

Authorizations:
bearer
Request Body schema: application/json
required
adminId
required
integer

admin id

Responses

Request samples

Content type
application/json
{
  • "adminId": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cardinal Cruise token

Issue token for Cardinal Cruise library

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "jwt": "string"
}

Cards validate authentication

Cards validate authentication

Authorizations:
None
Request Body schema: application/json
required
jwt
required
string

JWT token

Responses

Request samples

Content type
application/json
{
  • "jwt": "string"
}

Response samples

Content type
application/json
{
  • "status": "REDIRECT",
  • "jwt": "string",
  • "acs_url": "string",
  • "pa_req": "string",
  • "transaction_id": "string"
}

Cards enrollment lookup

Cards enrollment lookup

Authorizations:
bearer
Request Body schema: application/json
required
jwt
required
string

JWT token

credit_card_number
required
string <= 16 characters
expiration_month
required
integer [ 1 .. 12 ]
expiration_year
required
integer
first_name
string
last_name
string
email
string

Responses

Request samples

Content type
application/json
{
  • "jwt": "string",
  • "credit_card_number": "string",
  • "expiration_month": 1,
  • "expiration_year": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "status": "REDIRECT",
  • "jwt": "string",
  • "acs_url": "string",
  • "pa_req": "string",
  • "transaction_id": "string"
}

Admins

Get current admin profile

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Change password

Change password of authenticated admin by old password

Authorizations:
bearer
Request Body schema: application/json
old_password
string <password>

Old password

new_password
string <password>

New password

Responses

Request samples

Content type
application/json
{
  • "old_password": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Admins

Get a paginated list of admins filtered by defined criteria

Authorizations:
bearer
query Parameters
page
integer <int64>

Page number

per_page
integer <int64> [ 1 .. 100 ]

Number of records per page. Defaults to 15 when omitted.

partner_ids
Array of integers <int64> [ items <int64 > ]
role_ids
Array of integers <int64> [ items <int64 > ]
status
string
Enum: "active" "inactive" "suspended"
search_phrase
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create admin

Create a new admin

Authorizations:
bearer
Request Body schema: application/json
required
status
required
string
Enum: "active" "inactive" "suspended" "closed"
parent_id
integer <int64>
title
required
string
Enum: "Mr." "Mrs." "Ms." "Prof." "Dr." "Gen." "Sen." "HRH."
first_name
required
string
middle_name
string
last_name
required
string
email
required
string <email>
username
string
password
string <password>
country_id
integer <int64>
area_id
integer <int64>
city_id
integer <int64>
address_1
string
address_2
string
static_ip
string <ip>
profile_image_id
integer <int64> (image_id)

the id of the image in the database

login_methods
required
Array of strings
Items Enum: "credentials" "oauth"

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "parent_id": 0,
  • "title": "Mr.",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "password": "pa$$word",
  • "country_id": 0,
  • "area_id": 0,
  • "city_id": 0,
  • "address_1": "string",
  • "address_2": "string",
  • "static_ip": "127.0.0.1",
  • "profile_image_id": 0,
  • "login_methods": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Show Admin

Show a specific admin

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update admin

Update a specific admin

Authorizations:
bearer
Request Body schema: application/json
required
status
required
string
Enum: "active" "inactive" "suspended" "closed"
parent_id
integer <int64>
title
required
string
Enum: "Mr." "Mrs." "Ms." "Prof." "Dr." "Gen." "Sen." "HRH."
first_name
required
string
middle_name
string
last_name
required
string
email
required
string <email>
username
required
string
password
string <password>
country_id
integer <int64>
area_id
integer <int64>
city_id
integer <int64>
address_1
string
address_2
string
static_ip
string <ip>
profile_image_id
integer <int64> (image_id)

the id of the image in the database

login_methods
required
Array of strings
Items Enum: "credentials" "oauth"

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "parent_id": 0,
  • "title": "Mr.",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "password": "pa$$word",
  • "country_id": 0,
  • "area_id": 0,
  • "city_id": 0,
  • "address_1": "string",
  • "address_2": "string",
  • "static_ip": "127.0.0.1",
  • "profile_image_id": 0,
  • "login_methods": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete admin

Delete a specific admin

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{ }

Get partner list for admin

edit_admins

Authorizations:
bearer
path Parameters
admin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to admin

assign_admin_partner

Authorizations:
bearer
path Parameters
admin_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to admin

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach partner from admin

assign_admin_partner

Authorizations:
bearer
path Parameters
admin_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from admin

Responses

Response samples

Content type
application/json
{ }

Get roles list for admin

view_roles

Authorizations:
bearer
path Parameters
admin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add role to admin

assign_admin_type

Authorizations:
bearer
path Parameters
admin_id
required
string
Request Body schema: application/json
required
role_id
required
string

Role Id that you want attach to admin

Responses

Request samples

Content type
application/json
{
  • "role_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach role from admin

delete_roles

Authorizations:
bearer
path Parameters
admin_id
required
string
query Parameters
role_id
required
string

Role Id that you want detach from admin

Responses

Response samples

Content type
application/json
{ }

Reset auth method

reset_auth_method

Authorizations:
bearer
path Parameters
admin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Send reset password link by admin id

Send reset password link to the specified admin

Authorizations:
bearer
Request Body schema: application/json
required
adminId
required
integer

admin id

Responses

Request samples

Content type
application/json
{
  • "adminId": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Affiliates

Get Affiliates

view_affiliates

Authorizations:
bearer
query Parameters
page
integer <int64>

Page number

per_page
integer <int64> [ 1 .. 100 ]

Number of records per page. Defaults to 15 when omitted.

partner_ids
Array of strings
country_ids
Array of strings
category_ids
Array of strings
status
string
Enum: "enabled" "disabled"
search_phrase
string

Search by name (partial match) and id (exact match)

order_by
string
Enum: "id_asc" "id_desc" "created_at_asc" "created_at_desc"

order by id, created_at (Ascending, Descending)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create affiliate

add_affiliates

Authorizations:
bearer
Request Body schema: application/json
required
image_id
string
name
required
string
description
string
contact_name
string
contact_email
string
contact_number
string
contact_website
string
address_1
string
address_2
string
country_id
required
string
area_id
string
city_id
string
status
required
string
Enum: "enabled" "disabled"
category_id
string

Responses

Request samples

Content type
application/json
{
  • "image_id": "string",
  • "name": "string",
  • "description": "string",
  • "contact_name": "string",
  • "contact_email": "string",
  • "contact_number": "string",
  • "contact_website": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "country_id": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "status": "active",
  • "category_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get affiliate by id

view_affiliates

Authorizations:
bearer
path Parameters
affiliate_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update affiliate by id

edit_affiliates

Authorizations:
bearer
path Parameters
affiliate_id
required
string
Request Body schema: application/json
required
image_id
string
name
required
string
description
string
contact_name
string
contact_email
string
contact_number
string
contact_website
string
address_1
string
address_2
string
country_id
required
string
area_id
string
city_id
string
status
required
string
Enum: "enabled" "disabled"
category_id
string

Responses

Request samples

Content type
application/json
{
  • "image_id": "string",
  • "name": "string",
  • "description": "string",
  • "contact_name": "string",
  • "contact_email": "string",
  • "contact_number": "string",
  • "contact_website": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "country_id": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "status": "active",
  • "category_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete affiliate by id

delete_affiliates

Authorizations:
bearer
path Parameters
affiliate_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partner list for affiliate

view_affiliates

Authorizations:
bearer
path Parameters
affiliate_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to affiliate

edit_affiliates

Authorizations:
bearer
path Parameters
affiliate_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to affiliate

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach partner from affiliate

edit_affiliates

Authorizations:
bearer
path Parameters
affiliate_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from affiliate

Responses

Response samples

Content type
application/json
{ }

Affiliate Programs

Get affiliate programs list

Authorizations:
bearer
query Parameters
affiliate_ids
Array of arrays

Filter by affiliates

associated_partner_ids
Array of arrays

Filter by associated partners

contracted_partner_ids
Array of arrays

Filter by contracted partners

category_ids
Array of arrays

Filter by categories

is_enabled
string
Enum: "0" "1"

Filter by status

search_phrase
string
order_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Order by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create affiliate programs

Authorizations:
bearer
Request Body schema: application/json
required
is_enabled
required
boolean
is_visible
required
boolean
name
required
string
code
required
string
website_url
string
email
string
affiliate_id
required
integer
category_id
required
integer
type
required
integer
Enum: 1 2 3

1 => Points Conversion, 2 => Miles Conversion, 3 => Amount Donated

integration_type
required
integer
Enum: 1 2 3

1 => Real-time Integration, 2 => Offline integration supporting handback file, 3 => Offline integration not supporting handback file

integration_code
string
provider_program_code
string
image_id
integer <int64> (image_id)

the id of the image in the database

object (config)

Responses

Request samples

Content type
application/json
{
  • "is_enabled": true,
  • "is_visible": true,
  • "name": "string",
  • "code": "string",
  • "website_url": "string",
  • "email": "string",
  • "affiliate_id": 0,
  • "category_id": 0,
  • "type": 1,
  • "integration_type": 1,
  • "integration_code": "string",
  • "provider_program_code": "string",
  • "image_id": 0,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get affiliate program by id

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update affiliate program by id

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
Request Body schema: application/json
required
is_enabled
required
boolean
is_visible
required
boolean
name
required
string
code
required
string
website_url
string
email
string
affiliate_id
required
integer
category_id
required
integer
type
required
integer
Enum: 1 2 3

1 => Points Conversion, 2 => Miles Conversion, 3 => Amount Donated

integration_type
required
integer
Enum: 1 2 3

1 => Real-time Integration, 2 => Offline integration supporting handback file, 3 => Offline integration not supporting handback file

integration_code
string
provider_program_code
string
image_id
integer <int64> (image_id)

the id of the image in the database

object (config)

Responses

Request samples

Content type
application/json
{
  • "is_enabled": true,
  • "is_visible": true,
  • "name": "string",
  • "code": "string",
  • "website_url": "string",
  • "email": "string",
  • "affiliate_id": 0,
  • "category_id": 0,
  • "type": 1,
  • "integration_type": 1,
  • "integration_code": "string",
  • "provider_program_code": "string",
  • "image_id": 0,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete affiliate program by id

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get custom validation description

Get custom validation description based on program code and integration code

Authorizations:
bearer
query Parameters
program_code
required
string

program code

integration_code
string

integration code

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get partners list for affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach partner to affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to affiliate program

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach partner from affiliate

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from affiliate program

Responses

Response samples

Content type
application/json
{ }

Get redemption-configured partners list

Get redemption-configured partners list for affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get partner's redemption configuration

Get partner's redemption configuration for a specific affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create partner's redemption configuration

Create partner's redemption configuration for a specific affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
partner_id
required
string
Request Body schema: application/json
required
affiliate_program_id
required
string
partner_id
required
string
status
required
string
Enum: "enabled" "disabled"
object
object
is_terms_and_conditions_required
integer
Enum: 0 1
terms_and_conditions_url
string <url>
points_values_options_type
required
string
Enum: "free" "predefined" "range"
currency_id
string
points_value_rate
string
points_rounding_type
string
Enum: "none" "up" "down" "default"
minimum_points
string
maximum_points
string
predefined_points_values
Array of arrays
range_start
string
range_end
string
range_multiple_of
string
Array of objects
object
object
image_id
integer

Responses

Request samples

Content type
application/json
{
  • "affiliate_program_id": "string",
  • "partner_id": "string",
  • "status": "enabled",
  • "program_names": {
    },
  • "program_descriptions": {
    },
  • "is_terms_and_conditions_required": 0,
  • "terms_and_conditions_url": "string",
  • "points_values_options_type": "free",
  • "currency_id": "string",
  • "points_value_rate": "string",
  • "points_rounding_type": "none",
  • "minimum_points": "string",
  • "maximum_points": "string",
  • "predefined_points_values": [
    ],
  • "range_start": "string",
  • "range_end": "string",
  • "range_multiple_of": "string",
  • "calculation_rules": [
    ],
  • "membership_placeholders": {
    },
  • "membership_specifications": {
    },
  • "image_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update partner's redemption configuration

Update partner's redemption configuration for a specific affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
partner_id
required
string
Request Body schema: application/json
required
affiliate_program_id
required
string
partner_id
required
string
status
required
string
Enum: "enabled" "disabled"
object
object
is_terms_and_conditions_required
integer
Enum: 0 1
terms_and_conditions_url
string <url>
points_values_options_type
required
string
Enum: "free" "predefined" "range"
currency_id
string
points_value_rate
string
points_rounding_type
string
Enum: "none" "up" "down" "default"
minimum_points
string
maximum_points
string
predefined_points_values
Array of arrays
range_start
string
range_end
string
range_multiple_of
string
Array of objects
object
object
image_id
integer

Responses

Request samples

Content type
application/json
{
  • "affiliate_program_id": "string",
  • "partner_id": "string",
  • "status": "enabled",
  • "program_names": {
    },
  • "program_descriptions": {
    },
  • "is_terms_and_conditions_required": 0,
  • "terms_and_conditions_url": "string",
  • "points_values_options_type": "free",
  • "currency_id": "string",
  • "points_value_rate": "string",
  • "points_rounding_type": "none",
  • "minimum_points": "string",
  • "maximum_points": "string",
  • "predefined_points_values": [
    ],
  • "range_start": "string",
  • "range_end": "string",
  • "range_multiple_of": "string",
  • "calculation_rules": [
    ],
  • "membership_placeholders": {
    },
  • "membership_specifications": {
    },
  • "image_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete partner's redemption configuration

Delete partner's redemption configuration for a specific affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get marketplace-configured partners list

Get marketplace-configured partners list for affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get partner's marketplace configuration

Get partner's marketplace configuration for a specific affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create partner's marketplace configuration

Create partner's marketplace configuration for a specific affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
partner_id
required
string
Request Body schema: application/json
required
required
object (base-configurations)
required
object (marketplace-reconciliation-config)

Responses

Request samples

Content type
application/json
{
  • "program": {
    },
  • "reconciliation": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update partner's marketplace configuration

Update partner's marketplace configuration for a specific affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
partner_id
required
string
Request Body schema: application/json
required
required
object (base-configurations)
required
object (marketplace-reconciliation-config)

Responses

Request samples

Content type
application/json
{
  • "program": {
    },
  • "reconciliation": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete partner's marketplace configuration

Delete partner's marketplace configuration for a specific affiliate program

Authorizations:
bearer
path Parameters
affiliate_program_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{ }

List bonus campaigns for affiliate program and partner

Authorizations:
bearer
path Parameters
affiliate_program_id
required
integer
partner_id
required
integer

Responses

Response samples

Content type
application/json
{}

Create a new bonus campaign

Authorizations:
bearer
path Parameters
affiliate_program_id
required
integer
partner_id
required
integer
Request Body schema: application/json
required
campaign_name
required
string <= 255 characters
description
string or null
bonus_type
required
integer
Enum: 1 2

1 fixed, 2 percentage

bonus_value
required
integer >= 1
minimum_points
integer or null >= 0

Required when bonus_type is 'fixed'

start_date
required
string <date>
end_date
required
string <date>

Must be on or after start_date

enabled
required
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "campaign_name": "Eid Promo 2026",
  • "description": "Special Eid promotion",
  • "bonus_type": "fixed",
  • "bonus_value": 200,
  • "minimum_points": 300,
  • "start_date": "2026-06-01",
  • "end_date": "2026-06-30",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get bonus campaign details

Authorizations:
bearer
path Parameters
affiliate_program_id
required
integer
partner_id
required
integer
campaign_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update bonus campaign

Updates bonus campaign fields based on campaign lifecycle state.

Always editable:

  • campaign_name, description, enabled

Editable only before campaign starts (start_date > today):

  • start_date, bonus_value, minimum_points (for FIXED campaigns only)

Editable until campaign expires (end_date >= today):

  • end_date

Never editable:

  • bonus_type (ignored if submitted)
Authorizations:
bearer
path Parameters
affiliate_program_id
required
integer
partner_id
required
integer
campaign_id
required
integer
Request Body schema: application/json
required
campaign_name
required
string <= 255 characters
description
string or null
enabled
required
boolean
start_date
string or null <date>

Only editable before the campaign starts (start_date > today).

end_date
string or null <date>

Only editable until the campaign expires (end_date >= today).

bonus_value
integer or null

Only editable before the campaign starts. For FIXED campaigns: fixed bonus points. For PERCENTAGE campaigns: percentage value (e.g., 20 for 20%).

minimum_points
integer or null

Only applicable and editable for FIXED bonus campaigns before the campaign starts.

Responses

Request samples

Content type
application/json
Example
{
  • "campaign_name": "Eid Promo 2026 - Updated",
  • "description": "Updated description",
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete bonus campaign (soft delete)

Authorizations:
bearer
path Parameters
affiliate_program_id
required
integer
partner_id
required
integer
campaign_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": 401,
  • "code": 0,
  • "title": "string",
  • "detail": "string",
  • "meta": { }
}

Members

Get members list

view_members

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

country_ids
Array of arrays

Filter by countries

segment_ids
Array of arrays

Filter by segments

tier_ids
Array of arrays

Filter by tiers

search
string

Search by first name, last name, email or mobile number

reference
string

Search by reference (with or without prefix)

partner_user_code
string

Search by partner user code

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create member

create_members

Authorizations:
bearer
Request Body schema: application/json
required
pin
required
string

4 digit pin code

title
string
Enum: "Mr." "Mrs." "Ms." "Prof." "Dr." "Gen." "Sen." "HRH."

Member title

first_name
required
string

Member first name

middle_name
string

Member middle name

last_name
required
string

Member last name

country_id
string

Country id

email
string

Member email

telephone_code
required
string

Member phone code

mobile
required
string

Member mobile number without code

image_id
string

Member image id

marital_status
string
Enum: "single" "married" "widowed" "divorced" "other"
gender
required
string
Enum: "m" "f" "o" "not selected"
lang_id
string

Member language

dob
string

Member birtdate

occupation_id
string

Member occupation

income_bracket
string
Enum: "$0 - $500" "$500 - $1,000" "$1,000 - $2,000" "$2,000 - $3,000" "$3,000 - $4,000" "$4,000 - $5,000" "$5,000 - $8,000" "$8,000 - $12,000" "$12,000 - $15,000" "More than $15,000"
num_children
required
integer
company_name
string
tag
string

Member tags

area_id
string
city_id
string
address_1
string
address_2
string
Array of objects (memberSettingsInput)

Responses

Request samples

Content type
application/json
{
  • "pin": "string",
  • "title": "Mr.",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "country_id": "string",
  • "email": "string",
  • "telephone_code": 93,
  • "mobile": "string",
  • "image_id": "string",
  • "marital_status": "single",
  • "gender": "m",
  • "lang_id": "string",
  • "dob": "1990-01-20",
  • "occupation_id": "string",
  • "income_bracket": "$0 - $500",
  • "num_children": 3,
  • "company_name": "string",
  • "tag": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get member by id

view_members

Authorizations:
bearer
path Parameters
member_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update member by id

edit_members

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
title
string
Enum: "Mr." "Mrs." "Ms." "Prof." "Dr." "Gen." "Sen." "HRH."

Member title

first_name
string

Member first name

middle_name
string

Member middle name

last_name
string

Member last name

country_id
string

Country id

email
string

Member email

telephone_code
string

Member phone code

mobile
string

Member mobile number without code

image_id
string

Member image id

marital_status
string
Enum: "single" "married" "widowed" "divorced" "other"
gender
string
Enum: "m" "f" "o" "not selected"
lang_id
string

Member language

dob
string

Member birtdate

occupation_id
string

Member occupation

income_bracket
string
Enum: "$0 - $500" "$500 - $1,000" "$1,000 - $2,000" "$2,000 - $3,000" "$3,000 - $4,000" "$4,000 - $5,000" "$5,000 - $8,000" "$8,000 - $12,000" "$12,000 - $15,000" "More than $15,000"
num_children
integer
company_name
string
tag
string

Member tags

area_id
string
city_id
string
address_1
string
address_2
string
Array of objects (memberSettingsInput)
is_verified
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "Mr.",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "country_id": "string",
  • "email": "string",
  • "telephone_code": 93,
  • "mobile": "string",
  • "image_id": "string",
  • "marital_status": "single",
  • "gender": "m",
  • "lang_id": "string",
  • "dob": "1990-01-20",
  • "occupation_id": "string",
  • "income_bracket": "$0 - $500",
  • "num_children": 3,
  • "company_name": "string",
  • "tag": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "settings": [
    ],
  • "is_verified": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete member by id

delete_members

Authorizations:
bearer
path Parameters
member_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partner list for member

view_members

Authorizations:
bearer
path Parameters
member_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to member

edit_members

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to member

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach partner from member

edit_members

Authorizations:
bearer
path Parameters
member_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from member

Responses

Response samples

Content type
application/json
{ }

Get references list for member

view_members

Authorizations:
bearer
path Parameters
member_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add reference to member

edit_members

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
number
required
string

Reference number

Responses

Request samples

Content type
application/json
{
  • "number": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete reference

edit_members

Authorizations:
bearer
path Parameters
member_id
required
string
reference_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partner balance for member

view_members

Authorizations:
bearer
path Parameters
member_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get network balance for member

view_members

Authorizations:
bearer
path Parameters
member_id
required
integer
network_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get pending negative reward transactions list for member

view_posted_transactions

Authorizations:
bearer
path Parameters
member_id
required
string
query Parameters
id
string
start_date
string
Example: start_date=2024-01-28
end_date
string
Example: end_date=2024-01-29

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get pending negative reward transaction totals for member

view_posted_transactions

Authorizations:
bearer
path Parameters
member_id
required
string
query Parameters
id
string
start_date
string
Example: start_date=2024-01-28
end_date
string
Example: end_date=2024-01-29

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get pending negative reward transaction info

view_posted_transactions

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Affiliate User Identifiers List

Retrieves a list of affiliate user identifiers.

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Affiliate User Identifier

Creates a new affiliate user identifier.

Authorizations:
bearer
query Parameters
member_id
string

Member ID

Request Body schema: application/json
required
partner_id
integer
affiliate_program_id
integer
is_preferred
boolean
identifier_value
string
first_name
string
last_name
string
email
string
mobile_number
string

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "affiliate_program_id": 0,
  • "is_preferred": true,
  • "identifier_value": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "mobile_number": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "partner_id": 0,
  • "affiliate_program_id": 0,
  • "is_preferred": true,
  • "identifier_value": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "mobile_number": "string"
}

Affiliate User Identifier

Retrieves affiliate user identifier by ID.

Authorizations:
bearer
query Parameters
member_id
string

Member ID

identifier_id
string

Affiliate User Identifier ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "partner_id": 0,
  • "affiliate_program_id": 0,
  • "is_preferred": true,
  • "identifier_value": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "mobile_number": "string"
}

Update Affiliate User Identifier

Update affiliate user identifier.

Authorizations:
bearer
query Parameters
member_id
string

Member ID

identifier_id
string

Affiliate User Identifier ID

Request Body schema: application/json
required
is_preferred
boolean
identifier_value
string
first_name
string
last_name
string
email
string
mobile_number
string

Responses

Request samples

Content type
application/json
{
  • "is_preferred": true,
  • "identifier_value": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "mobile_number": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "partner_id": 0,
  • "affiliate_program_id": 0,
  • "is_preferred": true,
  • "identifier_value": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "mobile_number": "string"
}

Delete Affiliate User Identifier

Deletes a specific affiliate user identifier.

Authorizations:
bearer
query Parameters
member_id
string

Member ID

identifier_id
string

Affiliate User Identifier ID

Responses

Response samples

Content type
application/json
{ }

Enroll accor member

enroll_member_aco

Authorizations:
bearer
Request Body schema: application/json
required
title
string
Enum: "Mr." "Mrs." "Ms."

Member title

first_name
required
string

Member first name

last_name
required
string

Member last name

partner_id
required
string
email
required
string

Member email

telephone_code
string

Member phone code

mobile
required
string

Member mobile number without code

lang_code
string

Member language

occupation_id
string

Member occupation

company_name
string
contract_expiry_date
string
client_confirmed
required
boolean
privacy_policy_accepted
required
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "Mr.",
  • "first_name": "string",
  • "last_name": "string",
  • "partner_id": "string",
  • "email": "string",
  • "telephone_code": 93,
  • "mobile": "string",
  • "lang_code": "string",
  • "occupation_id": "string",
  • "company_name": "string",
  • "contract_expiry_date": "string",
  • "client_confirmed": true,
  • "privacy_policy_accepted": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get accor member fields by member id

view_members

Authorizations:
bearer
path Parameters
member_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update accor member fields by member id

edit_aco_member

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
contract_expiry_date
required
string

Contract expiry date

membership_type
required
string
Enum: "Individual" "Group"

Membership type

Responses

Request samples

Content type
application/json
{
  • "contract_expiry_date": "string",
  • "membership_type": "Individual"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Re-trigger Welcome Email

send_welcome_email

Authorizations:
bearer
path Parameters
member_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get Accor transaction list for member

view_aco_transactions

Authorizations:
bearer
path Parameters
member_id
required
integer
query Parameters
search
string

Search by ID, Store or Description

type
string
Enum: "reward" "redemption" "expiry"
start_date
string
Example: start_date=2020-01-28
end_date
string
Example: end_date=2020-01-29

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Accor transaction info

view_aco_transactions

Authorizations:
bearer
path Parameters
member_id
required
integer
transaction_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get transaction list for member

view_posted_transactions

Authorizations:
bearer
path Parameters
member_id
required
string
query Parameters
search
string

Search by ID, Store or Description

type
string
Enum: "reward" "redemption" "expiry"
start_date
string
Example: start_date=2020-01-28
end_date
string
Example: end_date=2020-01-29

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get transaction totals for member

view_posted_transactions

Authorizations:
bearer
path Parameters
member_id
required
string
query Parameters
search
string

Search by ID, Store or Description

type
string
Enum: "reward" "redemption" "expiry"
start_date
string
Example: start_date=2020-01-28
end_date
string
Example: end_date=2020-01-29

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get transaction info

view_posted_transactions

Authorizations:
bearer
path Parameters
member_id
required
string
transaction_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Reverse Redeemption transaction

reverse_redemption_transaction

Authorizations:
bearer
path Parameters
member_id
required
string
transaction_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Resend redemption confirmation emails

retrigger_redemption_confirmation_emails

Authorizations:
bearer
path Parameters
member_id
required
string
transaction_id
required
string
Request Body schema: application/json
required
target
string
Enum: "admin" "client"

Responses

Request samples

Content type
application/json
{
  • "target": "admin"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Reverse Reward transaction

reverse_reward_transaction

Authorizations:
bearer
path Parameters
member_id
required
string
transaction_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get order list for member

view_orders

Authorizations:
bearer
path Parameters
member_id
required
string
query Parameters
status
string
Enum: "in_process" "pending" "approved" "rejected" "reversal_in_process" "reverted"
type
string
Enum: "item" "hotel" "flight" "car" "cashback" "affiliate" "user-transfer" "vop" "adhoc" "merchant"
start_date
string
Example: start_date=2020-01-28
end_date
string
Example: end_date=2020-01-29

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get order totals for member

view_orders

Authorizations:
bearer
path Parameters
member_id
required
string
query Parameters
status
string
Enum: "in_process" "pending" "approved" "rejected" "reversal_in_process" "reverted"
type
string
Enum: "item" "hotel" "flight" "car" "cashback" "affiliate" "user-transfer" "vop" "adhoc"
start_date
string
Example: start_date=2020-01-28
end_date
string
Example: end_date=2020-01-29

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get order info

view_orders

Authorizations:
bearer
path Parameters
member_id
required
string
order_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get order list for member

view_orders

Authorizations:
bearer
path Parameters
member_id
required
string
query Parameters
status
string
Enum: "in_process" "pending" "approved" "rejected" "reversal_in_process" "reverted"
type
string
Enum: "item" "hotel" "flight" "car" "cashback" "affiliate" "user-transfer" "vop" "adhoc" "merchant"
start_date
string
Example: start_date=2020-01-28
end_date
string
Example: end_date=2020-01-29

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Reverse order items

reverse_redemption_transaction

Authorizations:
bearer
path Parameters
member_id
required
string
order_id
required
string
query Parameters
item_codes
Array of arrays
delivery_codes
Array of arrays

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get affiliated partner list

affiliated-partner-list

Authorizations:
bearer
path Parameters
member_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Change member status

change-status

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
partner_id
required
integer
is_override
boolean
status
required
string
Enum: "active" "suspended" "closed"

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "is_override": true,
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Reward points

reward-points

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
partner_id
required
integer
store_id
required
integer
points
required
integer
invoice_number
string
transaction_date
required
string
notes
string
expiration_rule_id
required
integer or null

Point Expiration Rule id (must belong to the selected partner and be active, or be the partner's linked default rule when that rule has been deactivated). Use null for no expiry. Must be null when points is negative; a points expiration rule cannot be applied for negative bonus points.

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "store_id": 0,
  • "points": 0,
  • "invoice_number": "string",
  • "transaction_date": "string",
  • "notes": "string",
  • "expiration_rule_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reward Amount By Rule

reward amount by exception rule

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
partner_id
required
integer
store_id
required
integer
rule_id
required
integer
currency_id
required
integer
amount
required
number
invoice_number
string
transaction_date
required
string

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "store_id": 0,
  • "rule_id": 0,
  • "currency_id": 0,
  • "amount": 0,
  • "invoice_number": "string",
  • "transaction_date": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Redeem points

redeem-points

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
partner_id
required
integer
store_id
required
integer
currency_id
integer
type
required
string
Enum: "amount" "points"
amount
required
number
category
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "store_id": 0,
  • "currency_id": 0,
  • "type": "amount",
  • "amount": 0,
  • "category": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Redeem item

redeem-item

Authorizations:
bearer
path Parameters
member_id
required
integer
Request Body schema: application/json
required
product_redemption_channel_id
required
integer
country_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "product_redemption_channel_id": 0,
  • "country_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Re-trigger Welcome Email

send_welcome_email

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
partner_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Require password reset of member

require_password_reset

Authorizations:
bearer
path Parameters
member_id
required
integer
Request Body schema: application/json
required
partner_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Set home tier

set-home-tier

Authorizations:
bearer
path Parameters
member_id
required
integer
Request Body schema: application/json
required
old_tier_id
integer
tier_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "old_tier_id": 0,
  • "tier_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Set regular tier

set-regular-tier

Authorizations:
bearer
path Parameters
member_id
required
integer
Request Body schema: application/json
required
old_tier_id
integer
tier_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "old_tier_id": 0,
  • "tier_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Tier History

tier-history

Authorizations:
bearer
path Parameters
member_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Earned badges

endpoint returns list of earned badges for a member

Authorizations:
bearer
path Parameters
member_id
required
integer
query Parameters
partner_id
required
integer
search_phrase
string
is_active
boolean
page
integer
per_page
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Total Earned badges

endpoint returns total earned badges for a member

Authorizations:
bearer
path Parameters
member_id
required
integer
query Parameters
partner_id
required
integer
is_active
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Segments

Get segments list

view_segments

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

name
string

Search by name

is_manual
boolean

Filter by manual segments (if empty - all)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create segment

create_segments

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
partner_id
required
string
is_manual
required
boolean
partner_prefix
string
mapping_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": "string",
  • "is_manual": true,
  • "partner_prefix": "string",
  • "mapping_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get segment by id

view_segments

Authorizations:
bearer
path Parameters
segment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update segment by id

edit_segments

Authorizations:
bearer
path Parameters
segment_id
required
string
Request Body schema: application/json
required
name
string
partner_id
string
is_manual
boolean
partner_prefix
string
mapping_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": "string",
  • "is_manual": true,
  • "partner_prefix": "string",
  • "mapping_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete segment by id

delete_segments

Authorizations:
bearer
path Parameters
segment_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get criteria list for segment

view_segments

Authorizations:
bearer
path Parameters
segment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add criteria to segment

edit_segments

Authorizations:
bearer
path Parameters
segment_id
required
string
Request Body schema: application/json
required
field
required
string

Criteria name

value
object

Criteria parameters

Responses

Request samples

Content type
application/json
{
  • "field": "string",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach criteria from segment

edit_segments

Authorizations:
bearer
path Parameters
segment_id
required
string
query Parameters
criteria_id
required
string

Criteria Id that you want detach from segment

Responses

Response samples

Content type
application/json
{ }

Get member list for segment

view_segments

Authorizations:
bearer
path Parameters
segment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add member to segment

edit_segments

Authorizations:
bearer
path Parameters
segment_id
required
string
Request Body schema: application/json
required
member_id
required
string

Member Id that you want attach to segment

Responses

Request samples

Content type
application/json
{
  • "member_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach member from segment

edit_segments

Authorizations:
bearer
path Parameters
segment_id
required
string
query Parameters
member_id
required
string

Member Id that you want detach from segment

Responses

Response samples

Content type
application/json
{ }

Add member to segment from file

create_segments or edit_segments

Authorizations:
bearer
path Parameters
segment_id
required
string
Request Body schema: multipart/form-data
required
file
required
string <binary>

Member file that you want attach to segment

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Partner BIN

Get partner bin list

view_partner_bins

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

status
string
Enum: "Enrolled" "NotEnrolled"

Filter by status

search_phrase
string

Search by bin or card type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create partner bin

create_partner_bins

Authorizations:
bearer
Request Body schema: application/json
required
bin
required
string
partner_id
required
string
status
required
boolean
card_type
required
string

Responses

Request samples

Content type
application/json
{
  • "bin": "string",
  • "partner_id": "string",
  • "status": true,
  • "card_type": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get partner bin by id

view_partner_bins

Authorizations:
bearer
path Parameters
bin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update partner bin by id

edit_partner_bins

Authorizations:
bearer
path Parameters
bin_id
required
string
Request Body schema: application/json
required
name
string
partner_id
string
is_manual
boolean
partner_prefix
string
mapping_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": "string",
  • "is_manual": true,
  • "partner_prefix": "string",
  • "mapping_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete partner bin by id

delete_partner_bins

Authorizations:
bearer
path Parameters
bin_id
required
string

Responses

Response samples

Content type
application/json
{ }

Tiering programs

Get tiering programs list

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

is_enabled
boolean

Filter by status

name
string

Search by name

order_by
string
Enum: "created_at_asc" "created_at_desc"

Order by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create tiering program

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
partner_id
required
string
is_enabled
required
boolean
description
string
up_period
integer
down_period
integer
criteria_id
string
product_ids
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": "string",
  • "is_enabled": true,
  • "description": "string",
  • "up_period": 0,
  • "down_period": 0,
  • "criteria_id": "string",
  • "product_ids": [ ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get tiering program by id

Authorizations:
bearer
path Parameters
tiering_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update tiering program by id

Authorizations:
bearer
path Parameters
tiering_program_id
required
string
Request Body schema: application/json
required
name
string
partner_id
string
is_enabled
boolean
description
string
up_period
integer
down_period
integer
criteria_id
string
product_ids
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": "string",
  • "is_enabled": true,
  • "description": "string",
  • "up_period": 0,
  • "down_period": 0,
  • "criteria_id": "string",
  • "product_ids": [ ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete tiering program by id

Authorizations:
bearer
path Parameters
tiering_program_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get tiers list for tiering program

Authorizations:
bearer
path Parameters
tiering_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add tiers to tiering programs

Authorizations:
bearer
path Parameters
tiering_program_id
required
string
Request Body schema: application/json
required
name
string
lower_value
integer
upper_value
integer
partner_mapping_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lower_value": 0,
  • "upper_value": 0,
  • "partner_mapping_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update tier

Authorizations:
bearer
path Parameters
tiering_program_id
required
string
tier_id
required
string
Request Body schema: application/json
required
name
string
lower_value
integer
upper_value
integer
partner_mapping_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lower_value": 0,
  • "upper_value": 0,
  • "partner_mapping_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach tiers from tiering programs

Authorizations:
bearer
path Parameters
tiering_program_id
required
string
tier_id
required
string

Responses

Response samples

Content type
application/json
{ }

Update tier rank

Authorizations:
bearer
path Parameters
tiering_program_id
required
string
tier_id
required
string
Request Body schema: application/json
required
rank
integer

Responses

Request samples

Content type
application/json
{
  • "rank": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Loyalty programs

Get loyalty programs list

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

network_ids
Array of arrays

Filter by network or multiple networks

status
any

Filter by status (Enabled, Disabled)

name
string

Search by name

partner_name
string

Search by partner name

order_by
string
Enum: "created_at_asc" "created_at_desc"

Order by

per_page
integer

Number of items per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create loyalty program

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
partner_id
required
string
is_enabled
required
boolean
description
string
valid_from
string
valid_to
string
cashback_validity
integer
original_reward
required
number
currency_id
required
string
reward_pts
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": "string",
  • "is_enabled": true,
  • "description": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "cashback_validity": 0,
  • "original_reward": 0,
  • "currency_id": "string",
  • "reward_pts": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get loyalty program by id

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update loyalty program by id

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string
Request Body schema: application/json
required
name
required
string
partner_id
required
string
is_enabled
required
boolean
description
string
valid_from
string
valid_to
string
cashback_validity
integer
original_reward
required
number
currency_id
required
string
reward_pts
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": "string",
  • "is_enabled": true,
  • "description": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "cashback_validity": 0,
  • "original_reward": 0,
  • "currency_id": "string",
  • "reward_pts": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete loyalty program by id

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string

Responses

Response samples

Content type
application/json
{ }

Clone loyalty program

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get loyalty programs priorities

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Change loyalty program priority

Authorizations:
bearer
Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "priorities": [
    ]
}

Response samples

Content type
application/json
{ }

Get rules list for loyalty programs

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string
query Parameters
status
string or null
Enum: "Enable" "Disable"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add rules to loyalty programs

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string
Request Body schema: application/json
required
name
string <= 100 characters
key
string <= 100 characters
is_enabled
boolean
Array of objects

Every entry must be an object carrying both lang_id and name — an entry of any other shape is refused with 422.

type
string
Enum: "Points" "Price" "Event" "Tiers"
balance_type_id
integer
reward_pts
integer [ 0 .. 2147483647 ]

The points the rule awards — for a Bonus rule, the flat top-up paid per qualifying transaction. Required for every rule type except Tiers. Zero is accepted; a negative value is not, because an earning rule cannot deduct. The maximum is the storage limit, beyond which the value could not be kept.

currency_id
string
original_reward
integer
reward_cap_id
string
reward_tier_id
string
priority
integer
earning_type
integer
Default: 1
Enum: 1 2

1 = Base (the default), 2 = Bonus. A Bonus rule stacks on top of the base earning instead of replacing it, and must use the Price (fixed points) rule type — any other type is refused. Immutable: it cannot be changed once the rule exists. Descriptions come from loyalty_rule_earning_types on the enums catalog. Sent as a JSON number; a quoted string, a boolean or a fractional number is refused. A Bonus rule must also carry an occurrence policy.

active_from
string or null <date>

First day the Bonus rule is active, inclusive. Accepted on a Bonus rule only. An empty bound falls back to the loyalty program's own valid_from; the resolved period must start before it ends and must lie inside the program validity. Immutable.

active_to
string or null <date>

Last day the Bonus rule is active, inclusive. Same rules as active_from, against the program's valid_to.

object or null

The occurrence policy gating the Bonus rule: which of the member's qualifying transactions actually pay. Required on a Bonus rule — absent, null or {} is refused with a 422 on occurrence — and accepted on a Bonus rule only; a Base rule sends null or omits it. Refused alongside a reward_cap_id — a capped reward is not worth the rule value, so a reversal could not undo it. Immutable once the rule exists, because changing it would re-key every occurrence counter and make every member eligible again.

point_expiration_rule_id
integer or null

How points earned through this rule expire. An active point expiration rule of the program's partner (the partner default rule's id, or a specific rule). null = no expiry.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "key": "string",
  • "is_enabled": true,
  • "translations": [
    ],
  • "type": "Points",
  • "balance_type_id": 0,
  • "reward_pts": 0,
  • "currency_id": "string",
  • "original_reward": 0,
  • "reward_cap_id": "string",
  • "reward_tier_id": "string",
  • "priority": 0,
  • "earning_type": 1,
  • "active_from": "2019-08-24",
  • "active_to": "2019-08-24",
  • "occurrence": {
    },
  • "point_expiration_rule_id": 0,
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get rules history list for loyalty programs

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get rule

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string
rule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update rule

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string
rule_id
required
string
Request Body schema: application/json
required

Only the fields the request carries are changed. name and is_enabled are required and are always applied; key, priority, translations and point_expiration_rule_id are optional — omit one and the rule keeps its stored value, send it as null to clear it. translations is a complete replacement set: a language missing from a submitted list is removed, and [] or null removes them all.

The bonus configuration is create-only and is deliberately absent here: a rule's earning type, active period, occurrence policy and conditions are set once, by postLoyaltyProgramRules, and never change — changing an occurrence policy after it has started counting would re-key every occurrence counter and make every member eligible for the bonus again. A rule that needs different settings is deleted and created again.

name
required
string <= 100 characters
key
string or null <= 100 characters

Omit to keep the stored key; send null to clear it.

is_enabled
required
boolean
priority
integer or null

Omit to keep the stored priority; send null to clear it.

point_expiration_rule_id
integer or null

How points earned through this rule expire. An active point expiration rule of the program's partner, or the rule already linked to this rule when it has since been deactivated. Omit to keep the current linkage; null = no expiry.

Array of objects or null

The complete replacement set. Omit to leave the rule's translations untouched; an empty array or null removes them all. Every entry must be an object carrying both lang_id and name — an entry of any other shape is refused with 422.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "key": "string",
  • "is_enabled": true,
  • "priority": 0,
  • "point_expiration_rule_id": 0,
  • "translations": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach rule from loyalty programs

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string
rule_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get products list for loyalty program

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add product to loyalty programs

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string
Request Body schema: application/json
required
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach products from loyalty programs

Authorizations:
bearer
path Parameters
loyalty_program_id
required
string
query Parameters
id
required
string

Product ID that should be detached from loyalty program

Responses

Response samples

Content type
application/json
{ }

Banners

Get banners list

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

website_statuses
Array of arrays

Filter by statuses

mobile_statuses
Array of arrays

Filter by mobile statuses

lang_id
string

Filter by language

name
string

Search by name

order_by
string
Enum: "created_at_asc" "created_at_desc"

Order by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create banner

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
title
string
description
string
partner_id
required
string
lang_id
required
string
logged_in
boolean
logged_out
boolean
website_status
string
Enum: "online" "offline"
mobile_status
string
Enum: "online" "offline"
website_image_id
string
mobile_image_id
string
tablet_image_id
string
website_link
string
mobile_link
string
date_bound
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "partner_id": "string",
  • "lang_id": "string",
  • "logged_in": true,
  • "logged_out": true,
  • "website_status": "online",
  • "mobile_status": "online",
  • "website_image_id": "string",
  • "mobile_image_id": "string",
  • "tablet_image_id": "string",
  • "website_link": "string",
  • "mobile_link": "string",
  • "date_bound": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get banner by id

Authorizations:
bearer
path Parameters
banner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update banner by id

Authorizations:
bearer
path Parameters
banner_id
required
string
Request Body schema: application/json
required
name
string
title
string
description
string
partner_id
string
lang_id
string
logged_in
boolean
logged_out
boolean
website_status
string
Enum: "online" "offline"
mobile_status
string
Enum: "online" "offline"
website_image_id
string
mobile_image_id
string
tablet_image_id
string
website_link
string
mobile_link
string
date_bound
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "partner_id": "string",
  • "lang_id": "string",
  • "logged_in": true,
  • "logged_out": true,
  • "website_status": "online",
  • "mobile_status": "online",
  • "website_image_id": "string",
  • "mobile_image_id": "string",
  • "tablet_image_id": "string",
  • "website_link": "string",
  • "mobile_link": "string",
  • "date_bound": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete banner by id

Authorizations:
bearer
path Parameters
banner_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get page list for banner

Authorizations:
bearer
path Parameters
banner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add page to banner

Authorizations:
bearer
path Parameters
banner_id
required
string
Request Body schema: application/json
required
page
required
string

Page name that you want attach to banner

Responses

Request samples

Content type
application/json
{
  • "page": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach page from banner

Authorizations:
bearer
path Parameters
banner_id
required
string
query Parameters
page_id
required
string

Page that you want detach from banner

Responses

Response samples

Content type
application/json
{ }

Get tier list for banner

Authorizations:
bearer
path Parameters
banner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add tier to banner

Authorizations:
bearer
path Parameters
banner_id
required
string
Request Body schema: application/json
required
tier_id
required
string

Tier Id that you want attach to banner

Responses

Request samples

Content type
application/json
{
  • "tier_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach tier from banner

Authorizations:
bearer
path Parameters
banner_id
required
string
query Parameters
tier_id
required
string

Tier Id that you want detach from banner

Responses

Response samples

Content type
application/json
{ }

Get segment list for banner

Authorizations:
bearer
path Parameters
banner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add segment to banner

Authorizations:
bearer
path Parameters
banner_id
required
string
Request Body schema: application/json
required
segment_id
required
string

Segment Id that you want attach to banner

Responses

Request samples

Content type
application/json
{
  • "segment_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach segment from banner

Authorizations:
bearer
path Parameters
banner_id
required
string
query Parameters
segment_id
required
string

Segment Id that you want detach from banner

Responses

Response samples

Content type
application/json
{ }

Get country list for banner

Authorizations:
bearer
path Parameters
banner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add country to banner

Authorizations:
bearer
path Parameters
banner_id
required
string
Request Body schema: application/json
required
country_id
required
string

Country Id that you want attach to banner

Responses

Request samples

Content type
application/json
{
  • "country_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach country from banner

Authorizations:
bearer
path Parameters
banner_id
required
string
query Parameters
country_id
required
string

Country Id that you want detach from banner

Responses

Response samples

Content type
application/json
{ }

Brands

Get brands list

Authorizations:
bearer
query Parameters
per_page
integer

Number of items per page

search_phrase
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create brand

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
media_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "media_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get brand by id

Authorizations:
bearer
path Parameters
brand_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update brand by id

Authorizations:
bearer
path Parameters
brand_id
required
string
Request Body schema: application/json
required
name
required
string
media_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "media_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete brand by id

Authorizations:
bearer
path Parameters
brand_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get brands translations list

Authorizations:
bearer
path Parameters
brand_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create brand translation

Authorizations:
bearer
path Parameters
brand_id
required
string
Request Body schema: application/json
required
name
required
string
lang_id
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get brand translation by id

Authorizations:
bearer
path Parameters
brand_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update brand translation by id

Authorizations:
bearer
path Parameters
brand_id
required
string
id
required
string
Request Body schema: application/json
required
name
required
string
lang_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete brand translation by id

Authorizations:
bearer
path Parameters
brand_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{ }

Mobile Games

Get mobile games list

Authorizations:
bearer
query Parameters
id
string

Search by id

partner_ids
Array of integers <int64> [ items <int64 > ]
search
string
per_page
integer

Number of items per page

order_by
string
Enum: "id_asc" "id_desc" "created_at_asc" "created_at_desc"

Order by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create mobile game

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
start_date
required
string
end_date
required
string
media_id
integer
timer
required
integer
percentage
number
max_points_to_grant
integer
max_points_per_user
integer
enabled
required
integer
Enum: 0 1
difficulty
required
string
Enum: "easy" "medium" "hard"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "start_date": "2023-01-01",
  • "end_date": "2023-01-31",
  • "media_id": 0,
  • "timer": 0,
  • "percentage": 0,
  • "max_points_to_grant": 0,
  • "max_points_per_user": 0,
  • "enabled": 0,
  • "difficulty": "easy"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get mobile game by id

Authorizations:
bearer
path Parameters
game_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update mobile game by id

Authorizations:
bearer
path Parameters
game_id
required
string
Request Body schema: application/json
required
name
required
string
start_date
required
string
end_date
required
string
media_id
integer
timer
required
integer
percentage
number
max_points_to_grant
integer
max_points_per_user
integer
enabled
required
integer
Enum: 0 1
difficulty
required
string
Enum: "easy" "medium" "hard"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "start_date": "2023-01-01",
  • "end_date": "2023-01-31",
  • "media_id": 0,
  • "timer": 0,
  • "percentage": 0,
  • "max_points_to_grant": 0,
  • "max_points_per_user": 0,
  • "enabled": 0,
  • "difficulty": "easy"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete mobile game by id

Authorizations:
bearer
path Parameters
game_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partner list for mobile game

view_mobile_game

Authorizations:
bearer
path Parameters
game_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to mobile game

edit_mobile_game

Authorizations:
bearer
path Parameters
game_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to mobile game

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach partner from mobile game

edit_mobile_game

Authorizations:
bearer
path Parameters
game_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from mobile game

Responses

Response samples

Content type
application/json
{ }

Get country list for mobile game

view_mobile_game

Authorizations:
bearer
path Parameters
game_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add country to mobile game

edit_mobile_game

Authorizations:
bearer
path Parameters
game_id
required
string
Request Body schema: application/json
required
country_id
required
string

Country Id that you want attach to mobile game

Responses

Request samples

Content type
application/json
{
  • "country_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach country from mobile game

edit_mobile_game

Authorizations:
bearer
path Parameters
game_id
required
string
query Parameters
country_id
required
string

Country Id that you want detach from mobile game

Responses

Response samples

Content type
application/json
{ }

Networks

Get networks list

Authorizations:
bearer
query Parameters
id
string

Search by id

partner_ids
Array of integers <int64> [ items <int64 > ]
search
string
per_page
integer

Number of items per page

order_by
string
Enum: "id_asc" "id_desc" "created_at_asc" "created_at_desc"

Order by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create network

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
image_id
integer <int64> (image_id)

the id of the image in the database

status
required
string
Enum: "Active" "Inactive" "Suspended"
description
string
currency
required
string
currency_id
integer
value_in_currency
number
affiliate_name
required
string
affiliate_telephone
required
string
affiliate_address_1
required
string
affiliate_address_2
required
string
affiliate_country
integer
affiliate_city
integer
affiliate_area
integer
affiliate_main_telephone
required
string
affiliate_email
required
string <email>
affiliate_contact_name
required
string
affiliate_contact_telephone
required
string
affiliate_contact_ext
required
string
affiliate_contact_mobile
required
string
affiliate_contact_email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_id": 0,
  • "status": "Active",
  • "description": "string",
  • "currency": "string",
  • "currency_id": 0,
  • "value_in_currency": 0,
  • "affiliate_name": "string",
  • "affiliate_telephone": "string",
  • "affiliate_address_1": "string",
  • "affiliate_address_2": "string",
  • "affiliate_country": 0,
  • "affiliate_city": 0,
  • "affiliate_area": 0,
  • "affiliate_main_telephone": "string",
  • "affiliate_email": "user@example.com",
  • "affiliate_contact_name": "string",
  • "affiliate_contact_telephone": "string",
  • "affiliate_contact_ext": "string",
  • "affiliate_contact_mobile": "string",
  • "affiliate_contact_email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get network by id

Authorizations:
bearer
path Parameters
network_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update network by id

Authorizations:
bearer
path Parameters
network_id
required
string
Request Body schema: application/json
required
name
required
string
image_id
integer <int64> (image_id)

the id of the image in the database

status
required
string
Enum: "Active" "Inactive" "Suspended"
description
string
currency
required
string
currency_id
integer
value_in_currency
number
affiliate_name
required
string
affiliate_telephone
required
string
affiliate_address_1
required
string
affiliate_address_2
required
string
affiliate_country
integer
affiliate_city
integer
affiliate_area
integer
affiliate_main_telephone
required
string
affiliate_email
required
string <email>
affiliate_contact_name
required
string
affiliate_contact_telephone
required
string
affiliate_contact_ext
required
string
affiliate_contact_mobile
required
string
affiliate_contact_email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_id": 0,
  • "status": "Active",
  • "description": "string",
  • "currency": "string",
  • "currency_id": 0,
  • "value_in_currency": 0,
  • "affiliate_name": "string",
  • "affiliate_telephone": "string",
  • "affiliate_address_1": "string",
  • "affiliate_address_2": "string",
  • "affiliate_country": 0,
  • "affiliate_city": 0,
  • "affiliate_area": 0,
  • "affiliate_main_telephone": "string",
  • "affiliate_email": "user@example.com",
  • "affiliate_contact_name": "string",
  • "affiliate_contact_telephone": "string",
  • "affiliate_contact_ext": "string",
  • "affiliate_contact_mobile": "string",
  • "affiliate_contact_email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete network by id

Authorizations:
bearer
path Parameters
network_id
required
string

Responses

Response samples

Content type
application/json
{ }

Campaign Notifications

Get campaign notifications list

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

name
string

Search by name

type
string
Enum: "SMS" "Email"

Filter by type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create campaign notification

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
partner_id
required
integer
type
required
string
Enum: "SMS" "Email"
body
string
template_id
integer
subject
string
start_date
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": 0,
  • "type": "SMS",
  • "body": "string",
  • "template_id": 0,
  • "subject": "string",
  • "start_date": "2020-01-28 21:30:00"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get campaign notification by id

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update campaign notification by id

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string
Request Body schema: application/json
required
name
required
string
partner_id
required
integer
type
required
string
Enum: "SMS" "Email"
body
string
template_id
integer
subject
string
start_date
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": 0,
  • "type": "SMS",
  • "body": "string",
  • "template_id": 0,
  • "subject": "string",
  • "start_date": "2020-01-28 21:30:00"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete campaign notification by id

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string

Responses

Response samples

Content type
application/json
{ }

Send campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get member list for campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add member to campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string
Request Body schema: application/json
required
member_id
required
string

Member Id that you want attach to campaign notification

Responses

Request samples

Content type
application/json
{
  • "member_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach member from campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string
query Parameters
member_id
required
string

Member Id that you want detach from campaign notification

Responses

Response samples

Content type
application/json
{ }

Get tier list for campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add tier to campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string
Request Body schema: application/json
required
tier_id
required
string

Tier Id that you want attach to campaign notification

Responses

Request samples

Content type
application/json
{
  • "tier_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach tier from campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string
query Parameters
tier_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get segment list for campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add segment to campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string
Request Body schema: application/json
required
segment_id
required
string

Segment Id that you want attach to campaign notification

Responses

Request samples

Content type
application/json
{
  • "segment_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach segment from campaign notification

Authorizations:
bearer
path Parameters
campaign_notification_id
required
string
query Parameters
segment_id
required
string

Segment Id that you want detach from campaign notification

Responses

Response samples

Content type
application/json
{ }

Tickets

Get tickets list

view_tickets

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

customer_type
string
Enum: "Member" "Partner"

Filter by customer type

statuses
string
Enum: "In progress" "Closed" "Escalated"

Filter by statuses

type_id
string

Filter by type

search
string

Search by ticket body

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create ticket

create_tickets

Authorizations:
bearer
Request Body schema: application/json
required
status
required
string
Enum: "In progress" "Closed" "Escalated"
customer_type
string
Enum: "Member" "Partner"
type_id
string
partner_id
required
string
identity
string
member_id
string
ticket
required
string

Responses

Request samples

Content type
application/json
{
  • "status": "In progress",
  • "customer_type": "Member",
  • "type_id": "string",
  • "partner_id": "string",
  • "identity": "string",
  • "member_id": "string",
  • "ticket": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get ticket by id

view_tickets

Authorizations:
bearer
path Parameters
ticket_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update ticket by id

edit_tickets

Authorizations:
bearer
path Parameters
ticket_id
required
string
Request Body schema: application/json
required
status
string
Enum: "In progress" "Closed" "Escalated"
customer_type
string
Enum: "Member" "Partner"
type_id
string
partner_id
string
identity
string
member_id
string
ticket
string

Responses

Request samples

Content type
application/json
{
  • "status": "In progress",
  • "customer_type": "Member",
  • "type_id": "string",
  • "partner_id": "string",
  • "identity": "string",
  • "member_id": "string",
  • "ticket": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete ticket by id

delete_tickets

Authorizations:
bearer
path Parameters
ticket_id
required
string

Responses

Response samples

Content type
application/json
{ }

Update ticket member

edit_profiles

Authorizations:
bearer
path Parameters
member_id
required
string
Request Body schema: application/json
required
title
string
Enum: "Mr." "Mrs." "Ms." "Prof." "Dr." "Gen." "Sen." "HRH."

Member title

first_name
string

Member first name

middle_name
string

Member middle name

last_name
string

Member last name

country_id
string

Country id

email
string

Member email

telephone_code
string

Member phone code

mobile
string

Member mobile number without code

image_id
string

Member image id

marital_status
string
Enum: "single" "married" "widowed" "divorced" "other"
gender
string
Enum: "m" "f" "o" "not selected"
lang_id
string

Member language

dob
string

Member birtdate

occupation_id
string

Member occupation

income_bracket
string
Enum: "$0 - $500" "$500 - $1,000" "$1,000 - $2,000" "$2,000 - $3,000" "$3,000 - $4,000" "$4,000 - $5,000" "$5,000 - $8,000" "$8,000 - $12,000" "$12,000 - $15,000" "More than $15,000"
num_children
integer
company_name
string
tag
string

Member tags

area_id
string
city_id
string
address_1
string
address_2
string
Array of objects (memberSettingsInput)
is_verified
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "Mr.",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "country_id": "string",
  • "email": "string",
  • "telephone_code": 93,
  • "mobile": "string",
  • "image_id": "string",
  • "marital_status": "single",
  • "gender": "m",
  • "lang_id": "string",
  • "dob": "1990-01-20",
  • "occupation_id": "string",
  • "income_bracket": "$0 - $500",
  • "num_children": 3,
  • "company_name": "string",
  • "tag": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "settings": [
    ],
  • "is_verified": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Partners

Get partner gateways list

view_partners

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get auto generated reports list

view_partners

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get partners list

Authorizations:
bearer
query Parameters
network_ids
Array of arrays

Filter by network or multiple networks

partner_ids
Array of arrays

Filter by partner or multiple partners

country_ids
Array of arrays

Filter by country or multiple countries

category_ids
Array of arrays

Filter by category or multiple categories

name
string

Search by name

id
string

Search by id

status
string
Enum: "Enabled" "Disabled"

Filter by status (Enabled, Disabled)

is_top_level_partner
boolean

Filter by is top level partner

order_by
string
Enum: "created_at_asc" "created_at_desc"

order by created_at (Ascending, Descending)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create partner

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
code
string
status
string
Enum: "Enabled" "Disabled" "Suspended"
network_id
required
string
merchant_app
string
contact_email
string
category_id
required
string
image_id
string
cover_image_id
string
loyalty_program_logo_id
string
apple_wallet_logo_id
string
apple_wallet_icon_id
string
google_wallet_logo_id
string
email_image
string
lang_id
string
contact_website
string
password_expiry
integer
password_expiry_period
string
point_expiration_rule_id
integer or null

The partner's default point expiration rule. Must belong to this partner and be active — a deactivated rule keeps being applied to points already earned, but cannot be saved on the partner any more. Required when use_points_expiry is 1.

account_closure_points_expire
boolean
bonus_on_registration
string
parent_id
string
facebook
string
instagram
string
linkedin
string
youtube
string
twitter
string
bonus_on_registration_issued_by
string
bonus_on_registration_reward_points
string
bonus_on_registration_active
string
bonus_on_registration_product
string
estatement_config_logo
string
estatement_config_color_gradient1
string
estatement_config_color_gradient2
string
estatement_config_color_title
string
estatement_config_color_button
string
program_name
Array of arrays
partner_name_subject
Array of arrays
partner_name_content
Array of arrays
copyright
string
support_email
string
sales_email
string
white_label_sales_email
string
send_feedback_to_sales
string
from_email
string
website_url
string
email_image_id
string
can_reward_inactive
string
prevent_multiple_login
string
is_top_level_partner
string
automatic_transaction_import
string
contact_name
string
contact_number
string
whatsapp_number
string
general_manager
string
marketing_manager
string
country_id
string
area_id
string
city_id
string
address_1
string
address_2
string
prefix
string
color
string
secondary_color
string
parent_partner_mapping_id
string
Enum: "default" "3-steps barcode"
description
string
has_middleware
boolean
link_middleware_api
string
display_online
string
enforce_static_ip
string
brand_id
integer
google_maps_url
string
attribute1
string
attribute2
string
attribute3
string
attribute4
string
attribute5
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "status": "Enabled",
  • "network_id": "string",
  • "merchant_app": "string",
  • "contact_email": "string",
  • "category_id": "string",
  • "image_id": "string",
  • "cover_image_id": "string",
  • "loyalty_program_logo_id": "string",
  • "apple_wallet_logo_id": "string",
  • "apple_wallet_icon_id": "string",
  • "google_wallet_logo_id": "string",
  • "email_image": "string",
  • "lang_id": "string",
  • "contact_website": "string",
  • "password_expiry": 0,
  • "password_expiry_period": "string",
  • "point_expiration_rule_id": 0,
  • "account_closure_points_expire": true,
  • "bonus_on_registration": "string",
  • "parent_id": "string",
  • "facebook": "string",
  • "instagram": "string",
  • "linkedin": "string",
  • "youtube": "string",
  • "twitter": "string",
  • "bonus_on_registration_issued_by": "string",
  • "bonus_on_registration_reward_points": "string",
  • "bonus_on_registration_active": "string",
  • "bonus_on_registration_product": "string",
  • "estatement_config_logo": "string",
  • "estatement_config_color_gradient1": "string",
  • "estatement_config_color_gradient2": "string",
  • "estatement_config_color_title": "string",
  • "estatement_config_color_button": "string",
  • "program_name": [ ],
  • "partner_name_subject": [ ],
  • "partner_name_content": [ ],
  • "copyright": "string",
  • "support_email": "string",
  • "sales_email": "string",
  • "white_label_sales_email": "string",
  • "send_feedback_to_sales": "string",
  • "from_email": "string",
  • "website_url": "string",
  • "email_image_id": "string",
  • "can_reward_inactive": "string",
  • "prevent_multiple_login": "string",
  • "is_top_level_partner": "string",
  • "automatic_transaction_import": "string",
  • "contact_name": "string",
  • "contact_number": "string",
  • "whatsapp_number": "string",
  • "general_manager": "string",
  • "marketing_manager": "string",
  • "country_id": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "prefix": "string",
  • "color": "string",
  • "secondary_color": "string",
  • "parent_partner_mapping_id": "default",
  • "description": "string",
  • "has_middleware": true,
  • "link_middleware_api": "string",
  • "display_online": "string",
  • "enforce_static_ip": "string",
  • "brand_id": 0,
  • "google_maps_url": "string",
  • "attribute1": "string",
  • "attribute2": "string",
  • "attribute3": "string",
  • "attribute4": "string",
  • "attribute5": "string",
  • "website_translations": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get partner by id

Authorizations:
bearer
path Parameters
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update partner by id

Authorizations:
bearer
path Parameters
partner_id
required
string
Request Body schema: application/json
required
name
string
code
string
status
string
Enum: "Enabled" "Disabled" "Suspended"
network_id
string
merchant_app
string
contact_email
string
category_id
string
image_id
string
cover_image_id
string
loyalty_program_logo_id
string
apple_wallet_logo_id
string
apple_wallet_icon_id
string
google_wallet_logo_id
string
email_image
string
lang_id
string
contact_website
string
password_expiry
integer
password_expiry_period
string
point_expiration_rule_id
integer or null

The partner's default point expiration rule. Must belong to this partner and be active — a deactivated rule keeps being applied to points already earned, but cannot be saved on the partner any more. Required when use_points_expiry is 1.

account_closure_points_expire
boolean
bonus_on_registration
string
parent_id
string
facebook
string
instagram
string
linkedin
string
youtube
string
twitter
string
bonus_on_registration_issued_by
string
bonus_on_registration_reward_points
string
bonus_on_registration_active
string
bonus_on_registration_product
string
estatement_config_logo
string
estatement_config_color_gradient1
string
estatement_config_color_gradient2
string
estatement_config_color_title
string
estatement_config_color_button
string
program_name
Array of arrays
partner_name_subject
Array of arrays
partner_name_content
Array of arrays
copyright
string
support_email
string
sales_email
string
white_label_sales_email
string
send_feedback_to_sales
string
from_email
string
website_url
string
email_image_id
string
can_reward_inactive
string
prevent_multiple_login
string
is_top_level_partner
string
automatic_transaction_import
string
contact_name
string
contact_number
string
whatsapp_number
string
general_manager
string
marketing_manager
string
country_id
string
area_id
string
city_id
string
address_1
string
address_2
string
prefix
string
color
string
secondary_color
string
parent_partner_mapping_id
string
Enum: "default" "3-steps barcode"
description
string
has_middleware
boolean
link_middleware_api
string
display_online
string
enforce_static_ip
string
brand_id
integer
google_maps_url
string
attribute1
string
attribute2
string
attribute3
string
attribute4
string
attribute5
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "status": "Enabled",
  • "network_id": "string",
  • "merchant_app": "string",
  • "contact_email": "string",
  • "category_id": "string",
  • "image_id": "string",
  • "cover_image_id": "string",
  • "loyalty_program_logo_id": "string",
  • "apple_wallet_logo_id": "string",
  • "apple_wallet_icon_id": "string",
  • "google_wallet_logo_id": "string",
  • "email_image": "string",
  • "lang_id": "string",
  • "contact_website": "string",
  • "password_expiry": 0,
  • "password_expiry_period": "string",
  • "point_expiration_rule_id": 0,
  • "account_closure_points_expire": true,
  • "bonus_on_registration": "string",
  • "parent_id": "string",
  • "facebook": "string",
  • "instagram": "string",
  • "linkedin": "string",
  • "youtube": "string",
  • "twitter": "string",
  • "bonus_on_registration_issued_by": "string",
  • "bonus_on_registration_reward_points": "string",
  • "bonus_on_registration_active": "string",
  • "bonus_on_registration_product": "string",
  • "estatement_config_logo": "string",
  • "estatement_config_color_gradient1": "string",
  • "estatement_config_color_gradient2": "string",
  • "estatement_config_color_title": "string",
  • "estatement_config_color_button": "string",
  • "program_name": [ ],
  • "partner_name_subject": [ ],
  • "partner_name_content": [ ],
  • "copyright": "string",
  • "support_email": "string",
  • "sales_email": "string",
  • "white_label_sales_email": "string",
  • "send_feedback_to_sales": "string",
  • "from_email": "string",
  • "website_url": "string",
  • "email_image_id": "string",
  • "can_reward_inactive": "string",
  • "prevent_multiple_login": "string",
  • "is_top_level_partner": "string",
  • "automatic_transaction_import": "string",
  • "contact_name": "string",
  • "contact_number": "string",
  • "whatsapp_number": "string",
  • "general_manager": "string",
  • "marketing_manager": "string",
  • "country_id": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "prefix": "string",
  • "color": "string",
  • "secondary_color": "string",
  • "parent_partner_mapping_id": "default",
  • "description": "string",
  • "has_middleware": true,
  • "link_middleware_api": "string",
  • "display_online": "string",
  • "enforce_static_ip": "string",
  • "brand_id": 0,
  • "google_maps_url": "string",
  • "attribute1": "string",
  • "attribute2": "string",
  • "attribute3": "string",
  • "attribute4": "string",
  • "attribute5": "string",
  • "website_translations": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete partner by id

Authorizations:
bearer
path Parameters
partner_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get Partner Images List

Authorizations:
bearer
path Parameters
partner_id
required
string

Partner ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add Partner Images

Authorizations:
bearer
path Parameters
partner_id
required
string

Partner ID

query Parameters
image_ids
Array of arrays

Image ids

Responses

Response samples

Content type
application/json
{ }

Detach Partner Image

Authorizations:
bearer
path Parameters
partner_id
required
string

Partner ID

query Parameters
image_id
string

Image ID

Responses

Response samples

Content type
application/json
{ }

Get country list for partners

Authorizations:
bearer
path Parameters
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add country to partner

Authorizations:
bearer
path Parameters
partner_id
required
string
Request Body schema: application/json
required
country_id
required
string

Country Id that you want attach to partner

Responses

Request samples

Content type
application/json
{
  • "country_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach country from partner

Authorizations:
bearer
path Parameters
partner_id
required
string
query Parameters
country_id
required
string

Country Id that you want detach from partner

Responses

Response samples

Content type
application/json
{ }

Get channel list for partners

Authorizations:
bearer
path Parameters
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add channel to partner

Authorizations:
bearer
path Parameters
partner_id
required
string
Request Body schema: application/json
required
channel_id
required
string

Channel Id that you want attach to partner

Responses

Request samples

Content type
application/json
{
  • "channel_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach channel from partner

Authorizations:
bearer
path Parameters
partner_id
required
string
query Parameters
channel_id
required
string

Channel Id that you want detach from partner

Responses

Response samples

Content type
application/json
{ }

Get stores list

Authorizations:
bearer
path Parameters
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create store

Authorizations:
bearer
path Parameters
partner_id
required
string
Request Body schema: application/json
required
name
required
string
lng
number
lat
number
mapping_id
string
display_online
boolean
allow_booking
boolean
beacon_id
string
beacon_name
string
beacon_major
integer
beacon_minor
integer
opening_hours
string
country_id
string
area_id
string
city_id
string
street
string
floor
string
building
string
details
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lng": 0,
  • "lat": 0,
  • "mapping_id": "string",
  • "display_online": true,
  • "allow_booking": true,
  • "beacon_id": "string",
  • "beacon_name": "string",
  • "beacon_major": 0,
  • "beacon_minor": 0,
  • "opening_hours": "string",
  • "country_id": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "street": "string",
  • "floor": "string",
  • "building": "string",
  • "details": "string",
  • "pos": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get store by id

Authorizations:
bearer
path Parameters
partner_id
required
string
store_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update store by id

Authorizations:
bearer
path Parameters
partner_id
required
string
store_id
required
string
Request Body schema: application/json
required
name
required
string
lng
number
lat
number
mapping_id
string
display_online
boolean
allow_booking
boolean
beacon_id
string
beacon_name
string
beacon_major
integer
beacon_minor
integer
opening_hours
string
country_id
string
area_id
string
city_id
string
street
string
floor
string
building
string
details
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lng": 0,
  • "lat": 0,
  • "mapping_id": "string",
  • "display_online": true,
  • "allow_booking": true,
  • "beacon_id": "string",
  • "beacon_name": "string",
  • "beacon_major": 0,
  • "beacon_minor": 0,
  • "opening_hours": "string",
  • "country_id": "string",
  • "area_id": "string",
  • "city_id": "string",
  • "street": "string",
  • "floor": "string",
  • "building": "string",
  • "details": "string",
  • "pos": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete store by id

Authorizations:
bearer
path Parameters
partner_id
required
string
store_id
required
string

Responses

Response samples

Content type
application/json
{ }

Create pos

Authorizations:
bearer
path Parameters
partner_id
required
string
store_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update pos by id

Authorizations:
bearer
path Parameters
partner_id
required
string
store_id
required
string
pos_id
required
string
Request Body schema: application/json
required
name
string
mapping_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "mapping_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete pos by id

Authorizations:
bearer
path Parameters
partner_id
required
string
store_id
required
string
pos_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get linked partners list

Authorizations:
bearer
path Parameters
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add linked partner

Authorizations:
bearer
path Parameters
partner_id
required
string
Request Body schema: application/json
required
linked_partner_id
required
string

Partner Id that you want link to partner

Responses

Request samples

Content type
application/json
{
  • "linked_partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Unlink partner

Authorizations:
bearer
path Parameters
partner_id
required
string
query Parameters
linked_partner_id
required
string

Partner Id that you want to unlink

Responses

Response samples

Content type
application/json
{ }

Get reports list for partners

Authorizations:
bearer
path Parameters
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add report to partner

Authorizations:
bearer
path Parameters
partner_id
required
string
Request Body schema: application/json
required
report_id
required
string

Report Id that you want attach to partner

frequency
required
string
Enum: "not selected" "daily" "weekly" "monthly" "yearly"

Report frequency

Responses

Request samples

Content type
application/json
{
  • "report_id": "string",
  • "frequency": "not selected"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach report from partner

Authorizations:
bearer
path Parameters
partner_id
required
string
query Parameters
report_id
required
string

Report Id that you want detach from partner

Responses

Response samples

Content type
application/json
{ }

Add Partner Translation

Authorizations:
bearer
path Parameters
partner_id
required
string

Partner ID

query Parameters
lang_id
required
integer

Lang ID

field
required
string
Enum: "name" "description" "website"

Field name

value
required
string

Translation value

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Partner Translation

Authorizations:
bearer
path Parameters
partner_id
required
string

Partner ID

query Parameters
lang_id
required
integer

Lang ID

field
required
string
Enum: "name" "description" "website"

Field name

Responses

Response samples

Content type
application/json
{ }

Reports

Get Accor points rewarded business list

view_accor_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for processing date

end_date
required
string

Max value for processing date

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Accor points rewarded business totals

view_accor_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for processing date

end_date
required
string

Max value for processing date

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Export Accor points rewarded business as .csv

view_accor_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for processing date

end_date
required
string

Max value for processing date

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Accor points rewarded finance list

view_accor_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for processing date

end_date
required
string

Max value for processing date

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Accor points rewarded finance totals

view_accor_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for processing date

end_date
required
string

Max value for processing date

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Export Accor points rewarded finance as .csv

view_accor_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for processing date

end_date
required
string

Max value for processing date

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Generic All Redemptions list

view_blu_internal_reports

Authorizations:
bearer
query Parameters
Array of objects

transaction date

Array of objects

transaction date

network_id
string

Filter by network

partner_ids
string

Filter by partners

member_id
string

Filter by member

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Generic All Redemptions list as .csv

view_blu_internal_reports

Authorizations:
bearer
query Parameters
transaction_start_date
string

Min value for transaction date

transaction_end_date
string

Max value for transaction date

order_start_date
string

Min value for order date

order_end_date
string

Max value for order date

network_id
string

Filter by network

partner_ids
string

Filter by partners

member_id
string

Filter by member

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Generic All Redemptions totals

view_blu_internal_reports

Authorizations:
bearer
query Parameters
transaction_start_date
string

Min value for transaction date

transaction_end_date
string

Max value for transaction date

order_start_date
string

Min value for order date

order_end_date
string

Max value for order date

network_id
string

Filter by network

partner_ids
string

Filter by partners

member_id
string

Filter by member

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Request reward transactions generation

view_basic_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

transaction_date_exclude
boolean

Max value for transaction date

Array of objects

transaction date

posting_date_exclude
boolean

Determines if posting date should be in or out of given interval

partner_ids
required
Array of arrays

Filter by partners

network_ids
required
Array of arrays

Filter by networks

currency_id
integer

Filter by member

member_id
integer

Filter by member

new
boolean

Force generate fresh report

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request all catalog redemption transactions generation

view_basic_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

required
Array of objects

transaction date

network_id
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

member_id
integer

Filter by member

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request points redeemed by category generation

view_redemption_partner_rewarded_points_reports

Authorizations:
bearer
query Parameters
required
Array of objects

Report date

network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

category_ids
required
Array of arrays

Filter by categories

currency_id
integer

Display values in selected currency

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Get Categories

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Request redemption of partner issued points

view_redemption_reports

Authorizations:
bearer
query Parameters
required
object

Transaction dates

network_id
required
integer

Filter by partners

partner_ids
required
Array of integers

Filter by partners

span
required
string
Enum: "yearly" "monthly" "daily"

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request in-store redemption transactions generation

view_blu_internal_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

merchant_ids
required
Array of arrays

Filter by merchants

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request detailed in-store redemption transactions generation

view_blu_internal_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

merchant_ids
required
Array of arrays

Filter by merchants

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request file upload summary generation

view_premium_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

partner_id
required
integer

Filter by partners

network_id
required
integer

Filter by network

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request points rewarded per partner and user generation

view_basic_reports

Authorizations:
bearer
query Parameters
Array of objects

transaction created date

Array of objects

transaction posting date

network_id
required
integer

Filter by network

partner_id
required
Array of arrays

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Redemption overview generation

view_blu_internal_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request partner monthly performance generation

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partners

member_ids
Array of integers

Filter by members

required
Array of objects

transaction date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request points expiry generation

view_premium_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request points rewarded per reward product generation

view_basic_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

transaction_date_exclude
required
boolean

Determines if transaction date should be in or out of given interval

required
Array of objects

posting date

posting_date_exclude
required
boolean

Determines if posting date should be in or out of given interval

partner_ids
required
Array of arrays

Filter by partners

network_id
required
integer

Filter by network

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Get members list list

view_basic_reports

Authorizations:
bearer
query Parameters
partner_id
required
integer

Filter by partner

network_id
required
integer

Filter by network

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request next points to expire generation

view_premium_reports

Authorizations:
bearer
query Parameters
partner_id
required
Array of arrays

Filter by partner

network_id
required
Array of arrays

Filter by network

Array of objects

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Rewards only transactions generation

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

member_id
integer

Filter by member

currency_id
integer

Currency id

required
Array of objects

posting date

required
Array of objects

transaction date

posting_date_exclude
boolean

Exclude posting date

transaction_date_exclude
boolean

Exclude transaction date

max_records
integer

Exclude transaction date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Pay with Points

pay_with_points_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

required
Array of objects

Order creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Adhoc Redemption Transactions

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

member_id
required
integer

Filter by member

required
Array of objects

Order creation date

required
Array of objects

Transaction creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Adhoc Points Adjustment

view_premium_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

required
Array of objects

Creation date range

adjustment_type
string
Enum: "reward" "redemption"

The type of the adjustment

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Admins List

view_admin_management_and_audit_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
Array of arrays

Filter by partners

admin_id
required
integer

Filter by admin

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Carbon Offset Redemptions

view_redemption_partner_rewarded_points_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

member_id
required
integer

Filter by member

required
Array of objects

Order creation date

required
Array of objects

Transaction creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Mobile And Bill Payments (Digital Value) Redemption Transactions

view_redemption_partner_rewarded_points_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

member_id
required
integer

Filter by member

required
Array of objects

Order creation date

required
Array of objects

Transaction creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Performance Report

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

required
Array of objects

Date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Pending Negative Reward Transactions

view_pending_rewards_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

member_id
integer

Filter by member

transaction_date_exclude
boolean

Exclude posted date

created_date_exclude
boolean

Exclude created date

required
Array of objects

Transaction posted date

Array of objects

Transaction creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Pending Reversal Reward Transactions

view_blu_internal_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

member_id
integer

Filter by member

transaction_date_exclude
boolean

Exclude date

required
Array of objects

Transaction creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Balance Pending Members List

view_pending_rewards_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Points Rewarded Per Member

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

member_id
integer

Filter by member

required
Array of objects

Transaction posted date

required
Array of objects

Transaction creation date

transaction_date_exclude
boolean

Determines if transaction date should be in or out of given interval

posting_date_exclude
boolean

Determines if posting date should be in or out of given interval

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Marketplace Affiliate Program Orders

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

required
Array of objects

Order creation date

order_statuses
Array of arrays
affiliate_program_codes
Array of arrays

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Ascenda Report

view_redemption_partner_rewarded_points_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

required
Array of objects

Order creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Partner Points Used By Item

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

required
Array of objects

Transaction creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Profit And Lost For Items

view_basic_reports

Authorizations:
bearer
query Parameters
partner_id
required
integer

Filter by partner

required
Array of objects

Order creation date

is_reconciled
boolean

Is reconciled

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Catalogue Listing per Partner Report

view_blu_internal_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

country_id
integer

Filter by country

is_online
boolean

Get online only

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Voucher Redemption And Usage

view_blu_internal_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

merchant_ids
Array of integers

Filter by merchants

Array of objects

Redemption date

Array of objects

Voucher used date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Member Performance

view_basic_reports

Authorizations:
bearer
query Parameters
required
Array of objects

Filter by date

network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partners

member_id
integer

Filter by member

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Cashback Redemption Transactions

view_basic_reports

Authorizations:
bearer
query Parameters
Array of objects
Array of objects
network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partners

member_id
integer

Filter by member

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Points Summary Report

view_premium_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

required
Array of objects

Date

user_statuses
string

user statuses separated by comma

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Period Totals By Partner Report

view_blu_internal_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

period
required
string
Enum: "daily" "monthly" "yearly"
required
Array of objects

Transaction creation date

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request survey performance report generation

Queues a background ETL job that produces a CSV with one row per survey, enriched with engagement metrics scoped by activity date: invitations created and responses submitted within [date.from, date.to]. The survey's lifecycle dates are surfaced as columns but are not used for filtering metrics.

Requires view_blu_internal_reports permission.

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Filter by partners (must be within the admin's managed partners)

status_ids
Array of integers
Items Enum: 1 2 3 4 5

Filter by survey status. Values: 1=Draft, 2=Active, 3=Paused, 4=Completed, 5=Scheduled.

Scheduled surveys have not distributed yet and are always excluded from this report, so filtering by 5 returns no rows.

object

Activity date range. Filters invitation created_at and response submitted_at. Either bound may be omitted for an open-ended range; omitting both means "all time".

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Members List Per Segment Report

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

segment_id
required
integer

Filter by segment

fields
required
Array of strings

Optional fields

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request online vouchers redemption - marketplace partners report generation

Queues a background ETL job that produces the "Online Vouchers Redemption - Marketplace Partners" report: one row per marketplace online voucher order (OneCard, YouGotaGift, YouGotaGift Prepaid, Digital Value), identifiable by client order code and platform order code. Offline vouchers and non-item marketplace orders are excluded. Product Cost and Currency are the supplier cost frozen at order placement; orders placed before cost capture existed, and orders that never reached Approved (Pending, Rejected) and therefore have no projected cost, display N/A.

Requires view_blu_internal_reports permission.

Authorizations:
bearer
query Parameters
required
object

Order placement date range. Both bounds are required; to must not be earlier than from and the range must not exceed 6 months.

partner_ids
required
Array of integers

Filter by marketplace partners (must be within the admin's managed partners)

item_type
string
Enum: "ygag" "one-card" "digital-value"

Filter by supplier voucher item type. ygag covers both YouGotaGift and YouGotaGift Prepaid orders.

order_status
integer
Enum: 1 2 3 4 5

Filter by order status. Values: 1=Pending, 2=Approved, 3=Rejected, 4=Cancelled, 5=Reversed.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Get Members List Per Segment Optional Fields

view_basic_reports

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Request CLO cashback transactions generation

view_redemption_partner_rewarded_points_reports

Authorizations:
bearer
query Parameters
required
Array of objects

date

partner_id
required
integer

Filter by partner

network_id
integer

Filter by network

member_id
integer

Filter by member

card_number
string

Filter by card number

transaction_status
string
Enum: "posted" "pending"

Filter by transaction status

new
boolean

Force generate fresh report

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Get rewards only transactions list

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

currency_id
required
integer
member_id
integer

Filter by member

transaction_start_date
string
Example: transaction_start_date=2022-04-04
transaction_end_date
string
Example: transaction_end_date=2022-04-04
transaction_date_exclude
boolean
posting_start_date
string
Example: posting_start_date=2022-04-04
posting_end_date
string
Example: posting_end_date=2022-04-04
posting_date_exclude
string
Enum: "0" "1"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get rewards only transactions totals

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

currency_id
required
integer
member_id
integer

Filter by member

transaction_start_date
string
Example: transaction_start_date=2022-04-04
transaction_end_date
string
Example: transaction_end_date=2022-04-04
transaction_date_exclude
boolean
posting_start_date
string
Example: posting_start_date=2022-04-04
posting_end_date
string
Example: posting_end_date=2022-04-04
posting_date_exclude
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get rewards only transactions as .csv

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

currency_id
required
integer
member_id
integer

Filter by member

transaction_start_date
string
Example: transaction_start_date=2022-04-04
transaction_end_date
string
Example: transaction_end_date=2022-04-04
transaction_date_exclude
boolean
posting_start_date
string
Example: posting_start_date=2022-04-04
posting_end_date
string
Example: posting_end_date=2022-04-04
posting_date_exclude
string
Enum: "0" "1"
max_records
integer

Maximum allowed records to export

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get members list

view_basic_reports

Authorizations:
bearer
query Parameters
partner_id
required
integer

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Export members list

view_basic_reports

Authorizations:
bearer
query Parameters
partner_id
required
integer

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get members per segment list

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
any

Filter by partner

segment_id
required
any

Filter by segment

fields
string
Enum: "user_id" "reference_id" "ucid" "unique_partner_id" "first_name" "middle_name" "last_name" "gender" "age" "email" "user_status" "mobile_number" "marital_status" "num_children" "country" "city" "area" "occupation" "income_bracket" "dob" "points_balance" "next_points_to_expire" "company_name" "preferred_language" "nationality"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get members per segment as .csv

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
any

Filter by partner

segment_id
required
any

Filter by segment

fields
string
Enum: "user_id" "reference_id" "ucid" "unique_partner_id" "first_name" "middle_name" "last_name" "gender" "age" "email" "user_status" "mobile_number" "marital_status" "num_children" "country" "city" "area" "occupation" "income_bracket" "dob" "points_balance" "next_points_to_expire" "company_name" "preferred_language" "nationality"

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get members statement list

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

start_date
required
string
Example: start_date=2022-01-01

Filter by start date

end_date
required
string
Example: end_date=2022-01-02

Filter by end date

member_id
required
integer

Filter by members

currency_id
integer
Default: 6

Show result in selected currency

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Members Statement Totals

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

start_date
required
string
Example: start_date=2022-01-01

Filter by start date

end_date
required
string
Example: end_date=2022-01-02

Filter by end date

member_id
required
integer

Filter by members

currency_id
integer
Default: 6

Show result in selected currency

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Members Statement Report list as .csv

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

start_date
required
string
Example: start_date=2022-01-01

Filter by start date

end_date
required
string
Example: end_date=2022-01-02

Filter by end date

member_id
required
integer

Filter by members

currency_id
integer
Default: 6

Show result in selected currency

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Request Member Statemens generation

view_basic_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partners

required
Array of objects

transaction date

member_id
required
integer

Filter by members

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request redemptions by item generation

view_blu_internal_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request voucher redemptions generation

view_blu_internal_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

network_id
required
integer

Filter by network

partner_ids
required
Array of arrays

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Get next points to expire list

view_premium_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for points expiration date

end_date
required
string

Max value for points expiration date

partner_id
required
Array of arrays

Filter by partner

network_id
required
integer

Filter by network

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get next points to expire totals

view_premium_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for points expiration date

end_date
required
string

Max value for points expiration date

partner_id
required
Array of arrays

Filter by partner

network_id
required
integer

Filter by network

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get next points to expire as .csv

view_premium_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for points expiration date

end_date
required
string

Max value for points expiration date

partner_id
required
Array of arrays

Filter by partner

network_id
required
integer

Filter by network

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Accounts Closure Points Deducted

view_premium_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

start_date
required
string

Min value for transaction date

end_date
required
string

Max value for transaction date

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Export Accounts Closure Points Deducted as .csv

view_premium_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

start_date
required
string

Min value for transaction date

end_date
required
string

Max value for transaction date

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Accounts Closure Points Deducted totals

view_premium_reports

Authorizations:
bearer
query Parameters
network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

start_date
required
string

Min value for transaction date

end_date
required
string

Max value for transaction date

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get audit trail comprehensive report

view_admin_management_and_audit_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for event date

end_date
required
string

Max value for event date

actions
required
Array of arrays

Filter by actions

type
required
string

Filter by type

partner_id
required
integer

Filter by partner

success
required
boolean

Filter by success (0|1)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get audit trail comprehensive report export as .csv

view_admin_management_and_audit_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for event date

end_date
required
string

Max value for event date

actions
required
Array of arrays

Filter by actions

type
required
string

Filter by type

partner_id
required
integer

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Top Redeemers Report List

view_premium_reports

Authorizations:
bearer
query Parameters
partner_ids
required
Array of integers

Filter by partners

network_id
required
integer

Filter by network

start_date
required
string
Example: start_date=2022-01-01

Filter by starting date

end_date
required
string
Example: end_date=2022-01-02

Filter by ending date

currency_id
integer
Default: 6

Show result in selected currency

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Top Redeemers Report Totals

view_premium_reports

Authorizations:
bearer
query Parameters
partner_ids
required
Array of integers

Filter by partners

network_id
required
integer

Filter by network

start_date
required
string
Example: start_date=2022-01-01

Filter by starting date

end_date
required
string
Example: end_date=2022-01-02

Filter by ending date

currency_id
integer
Default: 6

Show result in selected currency

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Top Redeemers Report Export

view_premium_reports

Authorizations:
bearer
query Parameters
partner_ids
required
Array of integers

Filter by partners

network_id
required
integer

Filter by network

start_date
required
string
Example: start_date=2022-01-01

Filter by starting date

end_date
required
string
Example: end_date=2022-01-02

Filter by ending date

currency_id
integer
Default: 6

Show result in selected currency

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Request Top Earners generation

view_premium_reports

Authorizations:
bearer
query Parameters
required
Array of objects

Report period

network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partner

currency_id
required
integer

Show amount in given currency

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Get online vouchers redemption list

view_blu_internal_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for order creation date

end_date
required
string

Max value for order creation date

partner_ids
required
Array of arrays

Filter by partners

order_status
string
Enum: "Ordered" "Reversal"

Filter by status

item_type
string
Enum: "ygag" "one-card" "digital-value" "loynova"

Filter by supplier

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get online vouchers redemption list as .csv

view_blu_internal_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for order creation date

end_date
required
string

Max value for order creation date

partner_ids
required
Array of arrays

Filter by partners

order_status
string
Enum: "Ordered" "Reversal"

Filter by status

item_type
string
Enum: "ygag" "one-card" "digital-value" "loynova"

Filter by supplier

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Request online vouchers redemption list generation

view_blu_internal_reports

Authorizations:
bearer
query Parameters
required
Array of objects

transaction date

partner_ids
required
Array of arrays

Filter by partners

order_status
string
Enum: "Ordered" "Reversal"

Filter by status

item_type
string
Enum: "ygag" "one-card" "digital-value" "loynova"

Filter by supplier

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request Points Conversion Redemption generation

view_redemption_partner_rewarded_points_reports

Authorizations:
bearer
query Parameters
partner_id
string
network_id
string
member_id
string
affiliate_program_codes
Array of strings
order_statuses
Array of strings
Items Enum: "approved" "rejected" "reverted"
Array of objects
Array of objects

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Get Offline Vouchers list

view_blu_internal_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for points expiration date

end_date
required
string

Max value for points expiration date

network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partner

product_ids
Array of integers

Filter by product

supplier_ids
Array of integers

Filter by supplier

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Offline Vouchers totals

view_blu_internal_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for points expiration date

end_date
required
string

Max value for points expiration date

network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partner

product_ids
Array of integers

Filter by product

supplier_ids
Array of integers

Filter by supplier

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Offline Vouchers list as .csv

view_blu_internal_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for points expiration date

end_date
required
string

Max value for points expiration date

network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partner

product_ids
Array of integers

Filter by product

supplier_ids
Array of integers

Filter by supplier

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Points Expiry Report List

view_premium_reports

Authorizations:
bearer
query Parameters
partner_ids
required
Array of integers

Filter by partners

start_date
required
string
Example: start_date=2022-01-01

Filter by starting date

end_date
required
string
Example: end_date=2022-01-02

Filter by ending date

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Points Expiry Report Totals

view_premium_reports

Authorizations:
bearer
query Parameters
partner_ids
required
Array of integers

Filter by partners

start_date
required
string
Example: start_date=2022-01-01

Filter by starting date

end_date
required
string
Example: end_date=2022-01-02

Filter by ending date

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Points Expiry Report list as .csv

view_premium_reports

Authorizations:
bearer
query Parameters
partner_ids
required
Array of integers

Filter by partner

start_date
required
string
Example: start_date=2022-01-01

Filter by starting date

end_date
required
string
Example: end_date=2022-01-02

Filter by ending date

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Enrollment Summary list

view_premium_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for registration date

end_date
required
string

Max value for registration date

partner_ids
required
Array of arrays

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Enrollment Summary totals

view_premium_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for registration date

end_date
required
string

Max value for registration date

partner_ids
required
Array of arrays

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Enrollment Summary list as .csv

view_premium_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for registration date

end_date
required
string

Max value for registration date

partner_ids
required
Array of arrays

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get enrollments list

view_premium_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for member registration date

end_date
required
string

Max value for member registration date

partner_id
required
integer

Filter by partner

store_id
integer

Filter by store

member_id
integer

Filter by member

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get enrollments list as .csv

view_premium_reports

Authorizations:
bearer
query Parameters
start_date
required
string

Min value for member registration date

end_date
required
string

Max value for member registration date

partner_id
required
Array of arrays

Filter by partner

store_id
integer

Filter by store

member_id
integer

Filter by member

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Failed to Process Partner Reward Transactions

view_premium_reports

Authorizations:
bearer
query Parameters
required
Array of objects

Report period

partner_id
required
integer

Filter by partner

network_id
required
integer

Filter by network

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request Items profit and loss generation

view_blu_internal_reports

Authorizations:
bearer
query Parameters
required
Array of objects

Transaction date

required
Array of objects

Order date

network_id
required
integer

Filter by network

partner_id
required
integer

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request Redemption by partner used points vs others

view_blu_internal_reports

Authorizations:
bearer
query Parameters
required
Array of objects

Filter by date

partner_ids
string

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request Generic Marketplace Orders report generation

view_marketplace_reports

Authorizations:
bearer
query Parameters
required
Array of objects

Order date

network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Request All Catalog Marketplace Orders report generation

view_marketplace_reports

Authorizations:
bearer
query Parameters
required
Array of objects

Order date

network_id
required
integer

Filter by network

partner_ids
required
Array of integers

Filter by partners

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

Report Schedule

Get report schedules list

view_report_schedule

Authorizations:
bearer
query Parameters
report_codes
Array of strings
manager_partner_ids
Array of integers
frequencies
Array of integers
is_active
boolean
start_date
string <date>
end_date
string <date>
search_phrase
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create report schedule

create_report_schedule

Authorizations:
bearer
Request Body schema: application/json
required
One of
required
object
job_name
required
string
job_title
required
string
recipients
required
string
frequency
required
integer
schedule_day
integer
is_active
required
boolean
start_date
required
string <date>
end_date
required
string <date>
schedule_time
required
string <partial-time>

Time in 24-h format

Responses

Request samples

Content type
application/json
Example
{
  • "request": {
    },
  • "job_name": "string",
  • "job_title": "string",
  • "recipients": "string",
  • "frequency": 0,
  • "schedule_day": 0,
  • "is_active": true,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "schedule_time": "string"
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Get report by id

view_report_schedule

Authorizations:
bearer
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Update report schedule by id

edit_report_schedule

Authorizations:
bearer
path Parameters
id
required
integer
Request Body schema: application/json
required
One of
required
object
job_name
required
string
job_title
required
string
recipients
required
string
frequency
required
integer
schedule_day
integer
is_active
required
boolean
start_date
required
string <date>
end_date
required
string <date>
schedule_time
required
string <partial-time>

Time in 24-h format

Responses

Request samples

Content type
application/json
Example
{
  • "request": {
    },
  • "job_name": "string",
  • "job_title": "string",
  • "recipients": "string",
  • "frequency": 0,
  • "schedule_day": 0,
  • "is_active": true,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "schedule_time": "string"
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Delete report schedule by id

delete_report_schedule

Authorizations:
bearer
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{ }

Reward

Reward Accor points manual

aco_reward_points_manual

Authorizations:
bearer
Request Body schema: application/json
required
partner_id
required
integer
membership_number
required
string
reservation_number
required
string
guest_first_name
required
string
guest_last_name
required
string
room_net_amount
required
number
f_and_b_amount
required
number
currency_id
required
integer
market_segment_code
required
string
booking_date
string
checkin_date
string
checkout_date
string
stay_duration
integer
rate_code
string
should_skip_max_amount_rule
required
integer
Enum: 0 1

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "membership_number": "string",
  • "reservation_number": "string",
  • "guest_first_name": "string",
  • "guest_last_name": "string",
  • "room_net_amount": 0,
  • "f_and_b_amount": 0,
  • "currency_id": 0,
  • "market_segment_code": "string",
  • "booking_date": "string",
  • "checkin_date": "string",
  • "checkout_date": "string",
  • "stay_duration": 0,
  • "rate_code": "string",
  • "should_skip_max_amount_rule": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Partner Categories

Get partner categories list

view_categories

Authorizations:
bearer
query Parameters
id
string

Search by id

partner_ids
Array of arrays

Filter by partner or multiple partners

search
string

Search by name

order_by
string
Enum: "id_asc" "created_at_asc" "created_at_desc"

Order by id, created_at (Ascending, Descending), by default ordered by id desc

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create partner category

create_categories

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string

Partner category name

image_id
string

Image ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get partner categories list

view_categories

Authorizations:
bearer
query Parameters
id
string

Search by id

partner_ids
Array of arrays

Filter by partner or multiple partners

search
string

Search by name

order_by
string
Enum: "id_asc" "created_at_asc" "created_at_desc"

Order by id, created_at (Ascending, Descending), by default ordered by id desc

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create partner category

create_categories

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string

Partner category name

image_id
string

Image ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get partner category by id

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update partner category by id

edit_categories

Authorizations:
bearer
path Parameters
category_id
required
string
Request Body schema: application/json
required
name
string

Partner category name

image_id
string

Image ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete partner category by id

delete_categories

Authorizations:
bearer
path Parameters
category_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partner list for partner category

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to partner category

edit_categories

Authorizations:
bearer
path Parameters
category_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to partner category

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach partner from partner category

edit_categories

Authorizations:
bearer
path Parameters
category_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from partner category

Responses

Response samples

Content type
application/json
{ }

Get partner category translations list

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create partner category translation

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string
Request Body schema: application/json
required
name
required
string
lang_id
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get partner category translation by id

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update partner category translation by id

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string
id
required
string
Request Body schema: application/json
required
name
required
string
lang_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete partner category translation by id

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{ }

Product Categories

Get product categories list

Authorizations:
bearer
query Parameters
id
string

Search by id

partner_ids
Array of arrays

Filter by partner or multiple partners

tags
Array of arrays

Filter by tag names

search
string

Search by name

order_by
string
Enum: "id_asc" "created_at_asc" "created_at_desc"

Order by id, created_at (Ascending, Descending), by default ordered by id desc

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create product category

create_categories

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string

Product category name

parent_category_id
integer

Parent Category ID

web_image_id
string

Web Image ID

mobile_image_id
string

Mobile Image ID

tag_ids
Array of integers

Tag ids

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_category_id": 0,
  • "web_image_id": "string",
  • "mobile_image_id": "string",
  • "tag_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get product category by id

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update product category by id

edit_categories

Authorizations:
bearer
path Parameters
category_id
required
string
Request Body schema: application/json
required
name
required
string

Product category name

parent_category_id
integer

Parent Category ID

web_image_id
string

Web Image ID

mobile_image_id
string

Mobile Image ID

tag_ids
Array of integers

Tag ids

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_category_id": 0,
  • "web_image_id": "string",
  • "mobile_image_id": "string",
  • "tag_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete product category by id

delete_categories

Authorizations:
bearer
path Parameters
category_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partner list for product category

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to product category

edit_categories

Authorizations:
bearer
path Parameters
category_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to product category

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach partner from product category

edit_categories

Authorizations:
bearer
path Parameters
category_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from product category

Responses

Response samples

Content type
application/json
{ }

Get product category translations list

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create product category translation

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string
Request Body schema: application/json
required
name
required
string
lang_id
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get product category translation by id

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update product category translation by id

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string
id
required
string
Request Body schema: application/json
required
name
required
string
lang_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete product category translation by id

view_categories

Authorizations:
bearer
path Parameters
category_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{ }

Products

Get products

view_products

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partners

brand_ids
Array of arrays

Filter by brands

category_ids
Array of arrays

Filter by categories

supplier_ids
Array of arrays

Filter by suppliers

segment_ids
Array of arrays

Filter by segments

product_type_ids
Array of arrays

Filter by product types

display_channel_partner_ids
Array of arrays

Filter by display channels

usage_types
string
Enum: "reward" "redemption" "general"

Filter by usage types

display_online
boolean

Filter by display online

search_phrase
string

Search by product name, brand name, model name, product map ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create product

create_products

Authorizations:
bearer
Request Body schema: application/json
required
is_active
required
boolean
name
required
string
brand_id
required
integer
category_id
required
integer
model
required
string
sub_model
required
string
description
required
string
cover_image_id
integer
image_ids
Array of arrays
is_voucher
required
boolean
electronic_delivery
required
boolean
weight
number <double>
volume
number <double>

Responses

Request samples

Content type
application/json
{
  • "is_active": true,
  • "name": "string",
  • "brand_id": 0,
  • "category_id": 0,
  • "model": "string",
  • "sub_model": "string",
  • "description": "string",
  • "cover_image_id": 0,
  • "image_ids": [ ],
  • "is_voucher": true,
  • "electronic_delivery": true,
  • "weight": 0.1,
  • "volume": 0.1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get product by id

view_products

Authorizations:
bearer
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update product by id

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
Request Body schema: application/json
required
is_active
required
boolean
name
required
string
brand_id
required
integer
category_id
required
integer
model
required
string
sub_model
required
string
description
required
string
cover_image_id
integer
image_ids
Array of arrays
is_voucher
required
boolean
electronic_delivery
required
boolean
weight
number <double>
volume
number <double>

Responses

Request samples

Content type
application/json
{
  • "is_active": true,
  • "name": "string",
  • "brand_id": 0,
  • "category_id": 0,
  • "model": "string",
  • "sub_model": "string",
  • "description": "string",
  • "cover_image_id": 0,
  • "image_ids": [ ],
  • "is_voucher": true,
  • "electronic_delivery": true,
  • "weight": 0.1,
  • "volume": 0.1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete product by id

delete_products

Authorizations:
bearer
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{ }

Delete product image by id

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
image_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get translations list for product

view_products

Authorizations:
bearer
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

create translation for product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
Request Body schema: application/json
required
name
required
string
model
string
sub_model
string
description
string
lang_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "model": "string",
  • "sub_model": "string",
  • "description": "string",
  • "lang_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update translation for product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
translation_id
required
string
Request Body schema: application/json
required
name
required
string
model
string
sub_model
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "model": "string",
  • "sub_model": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete translation from product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
translation_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partners list for product

view_products

Authorizations:
bearer
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate partner to product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to affiliate

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach partner from product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get reward partners list for product

view_products

Authorizations:
bearer
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create reward partner

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
Request Body schema: application/json
required
partner_id
required
integer
partner_mapping_id
string
sku
required
string
is_cumulative
required
boolean

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "partner_mapping_id": "string",
  • "sku": "string",
  • "is_cumulative": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update reward partner

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
reward_partner_id
required
string
Request Body schema: application/json
required
partner_id
required
integer
partner_mapping_id
string
sku
required
string
is_cumulative
required
boolean

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "partner_mapping_id": "string",
  • "sku": "string",
  • "is_cumulative": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete reward partner

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
reward_partner_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get redemption partners list for product

view_products

Authorizations:
bearer
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create redemption partner

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get redemption partner by id

view_products

Authorizations:
bearer
path Parameters
product_id
required
string
redemption_partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update redemption partner

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
redemption_partner_id
required
string
Request Body schema: application/json
required
supplier_id
required
integer
supplier_product_map_id
string
fulfilled_by_blu
required
boolean
product_link
string
additional_details
string
apple_wallet_strip_image
integer
google_wallet_strip_image
integer
display_online
required
boolean
hot_deal
required
boolean
show_offline
required
boolean
validity_dates
required
boolean
start_date
string
end_date
string
product_type_id
integer
promo_code
string
qty
required
integer
qty_stock_alert
required
integer
redemption_limit
integer
frequency
string
country_id
integer
original_price
required
number
original_retail_price
required
number
currency_id
required
integer
item_purchase_cost
required
number
item_purchase_currency
required
integer
face_value
number
face_value_currency_id
integer
out_of_stock_display
required
string (out_of_stock_display)
Enum: "hidden" "sold_out" "coming_soon"

Responses

Request samples

Content type
application/json
{
  • "supplier_id": 0,
  • "supplier_product_map_id": "string",
  • "fulfilled_by_blu": true,
  • "product_link": "string",
  • "additional_details": "string",
  • "apple_wallet_strip_image": 0,
  • "google_wallet_strip_image": 0,
  • "display_online": true,
  • "hot_deal": true,
  • "show_offline": true,
  • "validity_dates": true,
  • "start_date": "string",
  • "end_date": "string",
  • "product_type_id": 0,
  • "promo_code": "string",
  • "qty": 0,
  • "qty_stock_alert": 0,
  • "redemption_limit": 0,
  • "frequency": "string",
  • "country_id": 0,
  • "original_price": 0,
  • "original_retail_price": 0,
  • "currency_id": 0,
  • "item_purchase_cost": 0,
  • "item_purchase_currency": 0,
  • "face_value": 0,
  • "face_value_currency_id": 0,
  • "out_of_stock_display": "hidden"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get channels list for redemption partner

view_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create redemption partner channel

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
Request Body schema: application/json
required
partner_id
required
integer
max_cash_payment_percentage
integer

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "max_cash_payment_percentage": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update redemption partner channel

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
channel_id
required
string
Request Body schema: application/json
required
max_cash_payment_percentage
required
integer

Responses

Request samples

Content type
application/json
{
  • "max_cash_payment_percentage": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete channel from redemption partner

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
channel_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get segments list for redemption partner

view_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach partner redemption segment

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
Request Body schema: application/json
required
segment_id
required
string

Responses

Request samples

Content type
application/json
{
  • "segment_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

detach segment from redemption partner

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
segment_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get tiers list for redemption partner

view_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach partner redemption tier

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
Request Body schema: application/json
required
tier_id
required
string

Responses

Request samples

Content type
application/json
{
  • "tier_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

detach tier from redemption partner

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
tier_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get countries list for redemption partner

view_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create redemption country

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
Request Body schema: application/json
required
country_id
required
integer
is_active
required
boolean
shipping_company_id
integer
custom_tariffs_taxes
required
number
delivery_charges
required
number
currency_id
required
integer
delivery_cost
required
number
delivery_cost_currency_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "country_id": 0,
  • "is_active": true,
  • "shipping_company_id": 0,
  • "custom_tariffs_taxes": 0,
  • "delivery_charges": 0,
  • "currency_id": 0,
  • "delivery_cost": 0,
  • "delivery_cost_currency_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update redemption country

edit_products

Authorizations:
bearer
path Parameters
redemption_partner_id
required
string
country_id
required
string
Request Body schema: application/json
required
country_id
required
integer
is_active
required
boolean
shipping_company_id
integer
custom_tariffs_taxes
required
number
delivery_charges
required
number
currency_id
required
integer
delivery_cost
required
number
delivery_cost_currency_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "country_id": 0,
  • "is_active": true,
  • "shipping_company_id": 0,
  • "custom_tariffs_taxes": 0,
  • "delivery_charges": 0,
  • "currency_id": 0,
  • "delivery_cost": 0,
  • "delivery_cost_currency_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get universal product codes (UPC) list for product

view_products

Authorizations:
bearer
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate universal product code (UPC) to product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
Request Body schema: application/json
required
upc
required
string

Universal product code

Responses

Request samples

Content type
application/json
{
  • "upc": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update universal product code (UPC) for product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
upc_id
required
string
Request Body schema: application/json
required
upc
required
string

Universal product code

Responses

Request samples

Content type
application/json
{
  • "upc": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach universal product code (UPC) from product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
upc_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get e-voucher batches list for product

view_products

Authorizations:
bearer
path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create e-voucher batch for product

upload_e_voucher_batch

Authorizations:
bearer
path Parameters
product_id
required
string
Request Body schema: application/json
required
batch_name
required
string
type
string
Enum: "import_type" "generate_voucher_codes"
expiry_date
required
string <date>
file
string <binary>
code_format
string
Enum: "numeric" "alpha" "alphanumeric" "hyphenated"
length
integer [ 12 .. 200 ]
number
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "batch_name": "string",
  • "type": "import_type",
  • "expiry_date": "2019-08-24",
  • "file": "string",
  • "code_format": "numeric",
  • "length": 12,
  • "number": 1
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get e-voucher batch codes list

view_e_voucher_codes

Authorizations:
bearer
path Parameters
batch_id
required
string
query Parameters
status
string
Enum: "available" "redeemed" "used"
search_phrase
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete e-voucher batch

delete_e_voucher_batch

Authorizations:
bearer
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{ }

Associate merchant to product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
Request Body schema: application/json
required
partner_id
string

Merchant Id that you want attach to product

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach merchant from product

edit_products

Authorizations:
bearer
path Parameters
product_id
required
string
merchant_id
required
string

Responses

Response samples

Content type
application/json
{ }

Offers

Get offer list

view_offer

Authorizations:
bearer
Request Body schema: application/json
required
partner_ids
Array of integers

Filter by partner or multiple partners

country_ids
Array of integers

Filter by country or multiple countries

channel_ids
Array of integers

Filter by channel or multiple channels

statuses
Array of strings

Filter by statuses ( Active, Inactive)

types
Array of integers

Filter by types

search
string

Filter by name

Responses

Request samples

Content type
application/json
{
  • "partner_ids": [
    ],
  • "country_ids": [
    ],
  • "channel_ids": [
    ],
  • "statuses": [
    ],
  • "types": [
    ],
  • "search": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create offer

create_offer

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
category_id
required
integer
offer_type_id
integer
short_description
string
description
string
terms_and_conditions
string
cover_image_id
integer
image_id
integer
button_wording
string
display_online
boolean
validity_start_date
string
validity_end_date
string
start_date
string
end_date
string
logged_in
boolean
logged_out
boolean
email_text_promo_1
string
email_text_promo_2
string
external_link
string
vop_offer_code
string
discount
integer
max_cashback_amount
number
max_cashback_currency_id
integer
created_at
string
updated_at
string
status
string
Enum: "Active" "Inactive"
value
integer
reward_type
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category_id": 0,
  • "offer_type_id": 0,
  • "short_description": "string",
  • "description": "string",
  • "terms_and_conditions": "string",
  • "cover_image_id": 0,
  • "image_id": 0,
  • "button_wording": "string",
  • "display_online": true,
  • "validity_start_date": "2020-01-28",
  • "validity_end_date": "2020-01-28",
  • "start_date": "2020-01-28",
  • "end_date": "2020-01-28",
  • "logged_in": true,
  • "logged_out": true,
  • "email_text_promo_1": "string",
  • "email_text_promo_2": "string",
  • "external_link": "string",
  • "vop_offer_code": "string",
  • "discount": 0,
  • "max_cashback_amount": 0,
  • "max_cashback_currency_id": 0,
  • "created_at": "string",
  • "updated_at": "string",
  • "status": "Active",
  • "value": 0,
  • "reward_type": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get offer by id

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update offer by id

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
name
required
string
category_id
required
integer
offer_type_id
integer
short_description
string
description
string
terms_and_conditions
string
cover_image_id
integer
image_id
integer
button_wording
string
display_online
boolean
validity_start_date
string
validity_end_date
string
start_date
string
end_date
string
logged_in
boolean
logged_out
boolean
email_text_promo_1
string
email_text_promo_2
string
external_link
string
vop_offer_code
string
discount
integer
max_cashback_amount
number
max_cashback_currency_id
integer
created_at
string
updated_at
string
status
string
Enum: "Active" "Inactive"
value
integer
reward_type
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category_id": 0,
  • "offer_type_id": 0,
  • "short_description": "string",
  • "description": "string",
  • "terms_and_conditions": "string",
  • "cover_image_id": 0,
  • "image_id": 0,
  • "button_wording": "string",
  • "display_online": true,
  • "validity_start_date": "2020-01-28",
  • "validity_end_date": "2020-01-28",
  • "start_date": "2020-01-28",
  • "end_date": "2020-01-28",
  • "logged_in": true,
  • "logged_out": true,
  • "email_text_promo_1": "string",
  • "email_text_promo_2": "string",
  • "external_link": "string",
  • "vop_offer_code": "string",
  • "discount": 0,
  • "max_cashback_amount": 0,
  • "max_cashback_currency_id": 0,
  • "created_at": "string",
  • "updated_at": "string",
  • "status": "Active",
  • "value": 0,
  • "reward_type": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete offer by id

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get offer types

view_offer

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get offer categories

view_offer

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get offer statuses

view_offer

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get offer partners

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to offer

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
partner_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach partner from offer

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
partner_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0
}

Response samples

Content type
application/json
{ }

Get offer segments

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add segment to offer

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
segment_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "segment_id": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach segment from offer

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
segment_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "segment_id": 0
}

Response samples

Content type
application/json
{ }

Get offer countries

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add country to offer

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
country_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "country_id": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach country from offer

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
country_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "country_id": 0
}

Response samples

Content type
application/json
{ }

Get offer channels

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add channel to offer

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
channel_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "channel_id": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach channel from offer

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
channel_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "channel_id": 0
}

Response samples

Content type
application/json
{ }

Get offer tiers

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add tier to offer

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
tier_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "tier_id": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach tier from offer

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
tier_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "tier_id": 0
}

Response samples

Content type
application/json
{ }

Get offer membershiptiers

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add membershiptier to offer

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
membershiptier_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "membershiptier_id": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach membershiptier from offer

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
membershiptiers_id
integer

Responses

Request samples

Content type
application/json
{
  • "membershiptiers_id": 0
}

Response samples

Content type
application/json
{ }

Get offer cuisines

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add cuisine to offer

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
cuisine_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "cuisine_id": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach cuisine from offer

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
cuisine_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "cuisine_id": 0
}

Response samples

Content type
application/json
{ }

Get offer translations

view_offer

Authorizations:
bearer
path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add translation to offer

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
Request Body schema: application/json
required
name
required
string
lang_id
required
integer
description
integer
short_description
string
terms_and_condition
string
email_text_promo_1
string
email_text_promo_2
string
button_wording
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lang_id": 0,
  • "description": 0,
  • "short_description": "string",
  • "terms_and_condition": "string",
  • "email_text_promo_1": "string",
  • "email_text_promo_2": "string",
  • "button_wording": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update offer translation

edit_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
translation_id
required
string
Request Body schema: application/json
required
name
required
string
lang_id
required
integer
description
integer
short_description
string
terms_and_condition
string
email_text_promo_1
string
email_text_promo_2
string
button_wording
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lang_id": 0,
  • "description": 0,
  • "short_description": "string",
  • "terms_and_condition": "string",
  • "email_text_promo_1": "string",
  • "email_text_promo_2": "string",
  • "button_wording": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete offer translation

delete_offer

Authorizations:
bearer
path Parameters
offer_id
required
string
translation_id
required
string

Responses

Response samples

Content type
application/json
{ }

Roles

Get permissions list

view_roles

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get roles list

view_roles

Authorizations:
bearer
query Parameters
name
string

Filter by role name

partner_id
integer

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create role

create_roles

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
partner_id
required
integer
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": 0,
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get role by id

view_roles

Authorizations:
bearer
path Parameters
role_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update role by id

edit_roles

Authorizations:
bearer
path Parameters
role_id
required
string
Request Body schema: application/json
required
name
string
partner_id
integer
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": 0,
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete role by id

delete_roles

Authorizations:
bearer
path Parameters
role_id
required
string

Responses

Response samples

Content type
application/json
{ }

Estatements

Get estatements list

view_estatement

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

network_ids
Array of arrays

Filter by network or multiple networks

status
string

Filter by status

country_ids
Array of arrays

Filter by country or multiple countries

partner_category_id
string

Filter by partner category

is_top_level_partner
boolean

Filter by is_top_level_partner

partner_name
string

Search by partner name

order_by
string
Enum: "created_at_asc" "created_at_desc"

Order by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create estatement

create_estatement

Authorizations:
bearer
Request Body schema: application/json
required
title
required
string
description
required
string
partner_id
required
string
delivery_date
required
string
time
required
string
status
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "partner_id": "string",
  • "delivery_date": "string",
  • "time": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get estatement by id

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update estatement by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
title
required
string
description
required
string
partner_id
required
string
delivery_date
required
string
time
required
string
status
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "partner_id": "string",
  • "delivery_date": "string",
  • "time": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete estatement by id

delete_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get member list for estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add member to estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
member_id
required
string

Member Id that you want attach to estatement

Responses

Request samples

Content type
application/json
{
  • "member_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach member from estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
member_id
required
string

Member Id that you want detach from notification

Responses

Response samples

Content type
application/json
{ }

Get tier list for estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add tier to estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
tier_id
required
string

Tier Id that you want attach to estatement

Responses

Request samples

Content type
application/json
{
  • "tier_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach tier from estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
tier_id
required
string

Tier Id that you want detach from estatement

Responses

Response samples

Content type
application/json
{ }

Get segment list for estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add segment to estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
segment_id
required
string

Segment Id that you want attach to estatement

Responses

Request samples

Content type
application/json
{
  • "segment_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach segment from estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
segment_id
required
string

Segment Id that you want detach from estatement

Responses

Response samples

Content type
application/json
{ }

Get country list for estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add country to estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
country_id
required
string

Country Id that you want attach to estatement

Responses

Request samples

Content type
application/json
{
  • "country_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach country from estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
country_id
required
string

Country Id that you want detach from estatement

Responses

Response samples

Content type
application/json
{ }

Get estatement translations list

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create estatement translation

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
title
required
string
description
required
string
lang_id
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get estatement translation by id

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update estatement translation by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string
Request Body schema: application/json
required
title
required
string
description
required
string
lang_id
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete estatement translation by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get estatement offers list

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create estatement offer

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
type
required
string
rank
required
string
item_id
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "rank": "string",
  • "item_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get estatement offer by id

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update estatement offer by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string
Request Body schema: application/json
required
rank
required
string

Responses

Request samples

Content type
application/json
{
  • "rank": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete estatement offer by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{ }

Estatement offer types

view_estatement

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Estatement statuses

view_estatement

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Estatement delivery dates

view_estatement

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Preview Estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
lang
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Trigger Estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reward Caps

Get reward caps list

view_reward_caps

Authorizations:
bearer
Request Body schema: application/json
required
partner_ids
Array of integers

Filter by partner or multiple partners

search_phrase
string

Filter by name

Responses

Request samples

Content type
application/json
{
  • "partner_ids": [
    ],
  • "search_phrase": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Reward Cap

create_reward_caps

Authorizations:
bearer
Request Body schema: application/json
required
Array
name
string
reward_accumulator_id
string
partner_id
integer
value
number
aggregate_cap_id
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get reward cap by ID

view_reward_caps

Authorizations:
bearer
path Parameters
cap_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Reward Cap

edit_reward_caps

Authorizations:
bearer
path Parameters
cap_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Reward Cap

delete_reward_caps

Authorizations:
bearer
path Parameters
cap_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Currencies

Get currencies list

Authorizations:
bearer
query Parameters
search_phrase
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create currency

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
short_code
required
string
latest_rate
required
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_code": "string",
  • "latest_rate": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get currency by id

Authorizations:
bearer
path Parameters
currency_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update currency

Authorizations:
bearer
path Parameters
currency_id
required
integer
Request Body schema: application/json
required
name
required
string
short_code
required
string
latest_rate
required
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_code": "string",
  • "latest_rate": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Toggle currency display

Authorizations:
bearer
path Parameters
currency_id
required
integer
Request Body schema: application/json
required
status
required
boolean

Responses

Request samples

Content type
application/json
{
  • "status": true
}

Response samples

Content type
application/json
{ }

Get translations

Authorizations:
bearer
path Parameters
currency_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

create translation

Authorizations:
bearer
path Parameters
currency_id
required
integer
Request Body schema: application/json
required
value
required
string
lang_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "lang_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a translation

Authorizations:
bearer
path Parameters
currency_id
required
integer
translation_id
required
string
Request Body schema: application/json
required
value
required
string
lang_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "lang_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a translation

Authorizations:
bearer
path Parameters
currency_id
required
integer
translation_id
required
string

Responses

Response samples

Content type
application/json
{ }

Featured Collections

Get featured collections list

view_featured_collection

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

display_channels_ids
Array of arrays

Filter by display channel or multiple display channels

status
string
Enum: "enabled" "disabled"

Filter by status

search
string

Search by name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create featured collection

create_featured_collection

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
status
required
string
Enum: "enabled" "disabled"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "enabled"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get featured collection by id

view_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update featured collection by id

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string
Request Body schema: application/json
required
name
string
status
string
Enum: "enabled" "disabled"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "enabled"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete featured collection by id

delete_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partner list for featured collection

view_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to featured collection

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to featured collection

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach partner from featured collection

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from featured collection

Responses

Response samples

Content type
application/json
{ }

Get display channels list for featured collection

view_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add display channel to featured collection

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Channel Id that you want attach to featured collection

object

Channel translation names

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string",
  • "names": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update featured collection display channel

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string
id
required
string
Request Body schema: application/json
required
required
object

Channel translation names

Responses

Request samples

Content type
application/json
{
  • "names": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete featured collection display channel

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
string
query Parameters
id
required
string

Channel Id that you want to delete

Responses

Response samples

Content type
application/json
{ }

Get Featured Collection Items

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add Featured Collection Item

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
integer
Request Body schema: application/json
featured_item_id
required
integer
type
required
string
Enum: "offer" "product"

Responses

Request samples

Content type
application/json
{
  • "featured_item_id": 0,
  • "type": "offer"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Featured Collection Item

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
integer
Request Body schema: application/json
required
item_id
required
integer

Featured Collection Item ID that you want delete

Responses

Request samples

Content type
application/json
{
  • "item_id": 0
}

Response samples

Content type
application/json
{ }

Update Featured Collection Items Ranks

edit_featured_collection

Authorizations:
bearer
path Parameters
featured_collection_id
required
integer
query Parameters
object
Example: ranks=[{ id: 10, rank: 1 }, {id: 12, rank:2 }]

Object where id equal to featured_collection_item.id, rank equal to rank

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get possible types for Featured Collection Items

edit_featured_collection

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [ ]
}

Cron Jobs

Get cron jobs list

view_cron_jobs

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Run ron job

run_cron_jobs

Authorizations:
bearer
Request Body schema: application/json
required
signature
required
string

Cron job signature

Responses

Request samples

Content type
application/json
{
  • "signature": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Pos Entry Mode

Get Pos Entry Mode list

view_pos_entry_modes

Authorizations:
bearer
Request Body schema: application/json
required
search_phrase
string

Filter by id (strict), code, description

sort_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Sorting type for List

Responses

Request samples

Content type
application/json
{
  • "search_phrase": "string",
  • "sort_by": "created_at_asc"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Pos Entry Mode

create_pos_entry_modes

Authorizations:
bearer
Request Body schema: application/json
required
code
required
string
description
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Pos Entry Mode by id

view_pos_entry_modes

Authorizations:
bearer
path Parameters
pos_entry_mode_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Pos Entry Mode by id

edit_pos_entry_modes

Authorizations:
bearer
path Parameters
pos_entry_mode_id
required
integer
Request Body schema: application/json
required
code
required
string
description
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Pos Entry Mode by id

delete_pos_entry_modes

Authorizations:
bearer
path Parameters
pos_entry_mode_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Pos Environment Code

Get Pos Environment Code list

view_pos_environment_codes

Authorizations:
bearer
query Parameters
page
integer <int64>

Page number

per_page
integer <int64> [ 1 .. 100 ]

Number of records per page. Defaults to 15 when omitted.

Request Body schema: application/json
required
search_phrase
string

Filter by id (strict), code, description

sort_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Sorting type for List

Responses

Request samples

Content type
application/json
{
  • "search_phrase": "string",
  • "sort_by": "created_at_asc"
}

Response samples

Content type
application/json
{}

Create Pos Environment Code

create_pos_environment_codes

Authorizations:
bearer
Request Body schema: application/json
required
code
required
string = 1 characters ^[A-Za-z0-9]{1}$

Visa VLPS POS Environment Code, offset 194 (e.g. R = recurring). Exactly one alphanumeric character. Must not duplicate the code of an existing POS Environment Code that has not been deleted; a code freed by deletion can be created again.

description
required
string [ 1 .. 200 ] characters

Human-readable meaning of the code.

Responses

Request samples

Content type
application/json
{
  • "code": "R",
  • "description": "Recurring payment environment"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Pos Environment Code by id

view_pos_environment_codes

Authorizations:
bearer
path Parameters
pos_environment_code_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Pos Environment Code by id

edit_pos_environment_codes

Authorizations:
bearer
path Parameters
pos_environment_code_id
required
integer
Request Body schema: application/json
required
code
required
string = 1 characters ^[A-Za-z0-9]{1}$

Visa VLPS POS Environment Code, offset 194 (e.g. R = recurring). Exactly one alphanumeric character. Must not duplicate the code of an existing POS Environment Code that has not been deleted; a code freed by deletion can be created again.

description
required
string [ 1 .. 200 ] characters

Human-readable meaning of the code.

Responses

Request samples

Content type
application/json
{
  • "code": "R",
  • "description": "Recurring payment environment"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Pos Environment Code by id

delete_pos_environment_codes

Authorizations:
bearer
path Parameters
pos_environment_code_id
required
integer

Responses

Response samples

Content type
application/json
{ }

ECI

Get ECI list

view_ecis

Authorizations:
bearer
query Parameters
page
integer <int64>

Page number

per_page
integer <int64> [ 1 .. 100 ]

Number of records per page. Defaults to 15 when omitted.

Request Body schema: application/json
required
search_phrase
string

Filter by id (strict), code, description

sort_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Sorting type for List

Responses

Request samples

Content type
application/json
{
  • "search_phrase": "string",
  • "sort_by": "created_at_asc"
}

Response samples

Content type
application/json
{}

Create ECI

create_ecis

Authorizations:
bearer
Request Body schema: application/json
required
code
required
string [ 1 .. 2 ] characters ^[0-9]{1,2}$

Visa VLPS Electronic Commerce Indicator, offsets 192-193 (e.g. 02, 07). One or two digits. Must not duplicate the code of an existing ECI that has not been deleted; a code freed by deletion can be created again.

description
required
string [ 1 .. 200 ] characters

Human-readable meaning of the code.

Responses

Request samples

Content type
application/json
{
  • "code": "07",
  • "description": "Channel encrypted, cardholder not authenticated"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get ECI by id

view_ecis

Authorizations:
bearer
path Parameters
eci_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update ECI by id

edit_ecis

Authorizations:
bearer
path Parameters
eci_id
required
integer
Request Body schema: application/json
required
code
required
string [ 1 .. 2 ] characters ^[0-9]{1,2}$

Visa VLPS Electronic Commerce Indicator, offsets 192-193 (e.g. 02, 07). One or two digits. Must not duplicate the code of an existing ECI that has not been deleted; a code freed by deletion can be created again.

description
required
string [ 1 .. 200 ] characters

Human-readable meaning of the code.

Responses

Request samples

Content type
application/json
{
  • "code": "07",
  • "description": "Channel encrypted, cardholder not authenticated"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete ECI by id

delete_ecis

Authorizations:
bearer
path Parameters
eci_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Card Acceptor Ids

Get card acceptor ids list

Authorizations:
bearer
query Parameters
search_phrase
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create card acceptor id

Authorizations:
bearer
Request Body schema: application/json
required
value
string
description
string

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Card Acceptor Id

Authorizations:
bearer
path Parameters
card_acceptor_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update card acceptor id

Authorizations:
bearer
path Parameters
card_acceptor_id
required
integer
Request Body schema: application/json
required
value
string
description
string

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete card acceptor id

Authorizations:
bearer
path Parameters
card_acceptor_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Acquirer Bin

Get Acquirer Bin list

view_acquirer_bins

Authorizations:
bearer
Request Body schema: application/json
required
search_phrase
string

Filter by acquirer_bin, description, partner_id

Responses

Request samples

Content type
application/json
{
  • "search_phrase": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Acquirer Bin

create_acquirer_bins

Authorizations:
bearer
Request Body schema: application/json
required
acquirer_bin
required
string
partner_id
required
integer
description
string

Responses

Request samples

Content type
application/json
{
  • "acquirer_bin": "string",
  • "partner_id": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Acquirer Bin by id

view_acquirer_bins

Authorizations:
bearer
path Parameters
acquirer_bin_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Acquirer Bin by id

edit_acquirer_bins

Authorizations:
bearer
path Parameters
acquirer_bin_id
required
integer
Request Body schema: application/json
required
acquirer_bin
required
string
partner_id
required
integer
description
string

Responses

Request samples

Content type
application/json
{
  • "acquirer_bin": "string",
  • "partner_id": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Acquirer Bin by id

delete_acquirer_bins

Authorizations:
bearer
path Parameters
acquirer_bin_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Localization Keys

Get Localization Keys list

view_language_keys

Authorizations:
bearer
Request Body schema: application/json
required
search_phrase
string

Search by key, description, id (strict)

sort_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Sorting type for List

category
string
Enum: "generic" "backend" "website" "app"

Category of the key

Responses

Request samples

Content type
application/json
{
  • "search_phrase": "string",
  • "sort_by": "created_at_asc",
  • "category": "generic"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Localization Key

create_language_keys

Authorizations:
bearer
Request Body schema: application/json
required
key
required
string
description
required
string
is_platform_key
boolean
is_generic
boolean
category
string
Enum: "generic" "backend" "website" "app"

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "description": "string",
  • "is_platform_key": true,
  • "is_generic": true,
  • "category": "generic"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Localization Key by id

view_language_keys

Authorizations:
bearer
path Parameters
localization_key_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Localization Key by id

edit_language_keys

Authorizations:
bearer
path Parameters
localization_key_id
required
integer
Request Body schema: application/json
required
key
required
string
description
required
string
is_platform_key
boolean
is_generic
boolean
category
string
Enum: "generic" "backend" "website" "app"

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "description": "string",
  • "is_platform_key": true,
  • "is_generic": true,
  • "category": "generic"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Localization Key by id

delete_language_keys

Authorizations:
bearer
path Parameters
localization_key_id
required
integer

Responses

Response samples

Content type
application/json
{ }

List Partners of Localization Key

List the partners linked to a localization key.

Authorizations:
bearer
path Parameters
localization_key_id
required
integer

ID of the localization key

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Link Localization Key to Partners

Link specific partners to a localization key.

Authorizations:
bearer
path Parameters
localization_key_id
required
integer

ID of the localization key

Request Body schema: application/json
required
partners
required
Array of integers

Array of partner IDs to be linked

Responses

Request samples

Content type
application/json
{
  • "partners": [
    ]
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "description": "string",
  • "is_platform_key": true,
  • "is_generic": true,
  • "category": "generic"
}

Unlink Partner from Localization Key

Unlink a specific partner from a localization key.

Authorizations:
bearer
path Parameters
localization_key_id
required
integer

ID of the localization key

partner_id
required
integer

ID of the partner to be unlinked

Responses

Response samples

Content type
application/json
{ }

Language Keys

Get Language Keys List

view_language_keys

Authorizations:
bearer
query Parameters
search_phrase
string

Search by 'key'

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Language Key by id

view_language_keys

Authorizations:
bearer
path Parameters
language_key_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Language Key by id

edit_language_keys

Authorizations:
bearer
path Parameters
language_key_id
required
integer
Request Body schema: application/json
required
partner_id
integer
object

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "lang_keys": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Partner Language Key by id

delete_language_keys

Authorizations:
bearer
path Parameters
language_key_id
required
integer
Request Body schema: application/json
required
partner_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0
}

Response samples

Content type
application/json
{ }

Accumulators

Get Accumulators

view_accumulators

Authorizations:
bearer
query Parameters
page
integer <int64>

Page number

partner_ids
Array of integers
types
Array of integers
Items Enum: 1 2
search_phrase
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create accumulator

create_accumulators

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
partner_id
required
integer
frequency
required
string
Enum: "one_time" "monthly" "quarterly" "yearly"
type
required
integer
value_type
required
integer
currency_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": 0,
  • "frequency": "one_time",
  • "type": 0,
  • "value_type": 0,
  • "currency_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get accumulator by id

view_accumulators

Authorizations:
bearer
path Parameters
accumulator_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update accumulator by id

edit_accumulators

Authorizations:
bearer
path Parameters
accumulator_id
required
integer
Request Body schema: application/json
required
name
required
string
partner_id
required
integer
frequency
required
string
Enum: "one_time" "monthly" "quarterly" "yearly"
type
required
integer
value_type
required
integer
currency_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partner_id": 0,
  • "frequency": "one_time",
  • "type": 0,
  • "value_type": 0,
  • "currency_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete accumulator by id

delete_accumulators

Authorizations:
bearer
path Parameters
accumulator_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get accumulator Types

view_accumulators

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get accumulator Value Types

view_accumulators

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Estatements

Get estatements list

view_estatement

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

network_ids
Array of arrays

Filter by network or multiple networks

status
string

Filter by status

country_ids
Array of arrays

Filter by country or multiple countries

partner_category_id
string

Filter by partner category

is_top_level_partner
boolean

Filter by is_top_level_partner

partner_name
string

Search by partner name

order_by
string
Enum: "created_at_asc" "created_at_desc"

Order by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create estatement

create_estatement

Authorizations:
bearer
Request Body schema: application/json
required
title
required
string
description
required
string
partner_id
required
string
delivery_date
required
string
time
required
string
status
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "partner_id": "string",
  • "delivery_date": "string",
  • "time": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get estatement by id

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update estatement by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
title
required
string
description
required
string
partner_id
required
string
delivery_date
required
string
time
required
string
status
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "partner_id": "string",
  • "delivery_date": "string",
  • "time": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete estatement by id

delete_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get member list for estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add member to estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
member_id
required
string

Member Id that you want attach to estatement

Responses

Request samples

Content type
application/json
{
  • "member_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach member from estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
member_id
required
string

Member Id that you want detach from notification

Responses

Response samples

Content type
application/json
{ }

Get tier list for estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add tier to estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
tier_id
required
string

Tier Id that you want attach to estatement

Responses

Request samples

Content type
application/json
{
  • "tier_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach tier from estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
tier_id
required
string

Tier Id that you want detach from estatement

Responses

Response samples

Content type
application/json
{ }

Get segment list for estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add segment to estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
segment_id
required
string

Segment Id that you want attach to estatement

Responses

Request samples

Content type
application/json
{
  • "segment_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach segment from estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
segment_id
required
string

Segment Id that you want detach from estatement

Responses

Response samples

Content type
application/json
{ }

Get country list for estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add country to estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
country_id
required
string

Country Id that you want attach to estatement

Responses

Request samples

Content type
application/json
{
  • "country_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach country from estatement

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
country_id
required
string

Country Id that you want detach from estatement

Responses

Response samples

Content type
application/json
{ }

Get estatement translations list

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create estatement translation

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
title
required
string
description
required
string
lang_id
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get estatement translation by id

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update estatement translation by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string
Request Body schema: application/json
required
title
required
string
description
required
string
lang_id
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "lang_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete estatement translation by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get estatement offers list

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create estatement offer

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
Request Body schema: application/json
required
type
required
string
rank
required
string
item_id
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "rank": "string",
  • "item_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get estatement offer by id

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update estatement offer by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string
Request Body schema: application/json
required
rank
required
string

Responses

Request samples

Content type
application/json
{
  • "rank": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete estatement offer by id

edit_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{ }

Estatement offer types

view_estatement

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Estatement statuses

view_estatement

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Estatement delivery dates

view_estatement

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Preview Estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string
query Parameters
lang
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Trigger Estatement

view_estatement

Authorizations:
bearer
path Parameters
estatement_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reward Tiers

Get reward tiers list

view_reward_tiers

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

name
string

Search by name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create reward tiers

create_reward_tiers

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
reward_accumulator_id
required
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reward_accumulator_id": "string",
  • "range": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get reward tier by id

view_reward_tiers

Authorizations:
bearer
path Parameters
reward_tier_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update reward tier by id

edit_reward_tiers

Authorizations:
bearer
path Parameters
reward_tier_id
required
string
Request Body schema: application/json
required
name
required
string
reward_accumulator_id
required
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reward_accumulator_id": "string",
  • "range": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete reward tier by id

delete_reward_tiers

Authorizations:
bearer
path Parameters
reward_tier_id
required
string

Responses

Response samples

Content type
application/json
{ }

Countries

Get Countries list

view_countries

Authorizations:
bearer
Request Body schema: application/json
search_phrase
string

Filter by name, short_code, telephone_code

Responses

Request samples

Content type
application/json
{
  • "search_phrase": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Country

create_countries

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
telephone_code
required
string
iso_code
required
string
alpha3_code
required
string
short_code
required
string
postcode_regex
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "telephone_code": "string",
  • "iso_code": "string",
  • "alpha3_code": "string",
  • "short_code": "string",
  • "postcode_regex": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Country by id

view_countries

Authorizations:
bearer
path Parameters
country_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Country by id

edit_countries

Authorizations:
bearer
path Parameters
country_id
required
string
Request Body schema: application/json
required
name
required
string
telephone_code
required
string
iso_code
required
string
alpha3_code
required
string
short_code
required
string
postcode_regex
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "telephone_code": "string",
  • "iso_code": "string",
  • "alpha3_code": "string",
  • "short_code": "string",
  • "postcode_regex": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Country by id

delete_country

Authorizations:
bearer
path Parameters
country_id
required
string

Responses

Response samples

Content type
application/json
{ }

Upload Files

Get Upload Files list

view_uploaded_files

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner

source_id
integer
Enum: 1 2 3

Filter by Source [1 => sftp, 2 => admin api, 3 => partner api]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Upload file

Authorizations:
bearer
Request Body schema: multipart/form-data
required
partner_id
required
string

ID of the partner selected

file_type
required
string

File type

file
required
string <binary>

File to upload

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Merchants

Get merchants list

view_featured_collection

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

search
string

Filter by name

affiliate_partner_id
integer <int64>

Affiliate Partner ID

status
string
Enum: "active" "inactive"

Affiliate Partner Status

merchant_type
string
Enum: "reward" "redemption"

Affiliate Partner Type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create merchant

create_merchants

Authorizations:
bearer
Request Body schema: application/json
required
code
required
string
name
required
string
description
required
string
contact_name
string
contact_email
string
contact_phone_number
string
website
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "contact_name": "string",
  • "contact_email": "string",
  • "contact_phone_number": "string",
  • "website": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Merchant by id

view_merchant

Authorizations:
bearer
path Parameters
merchant_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Merchant by id

edit_merchant

Authorizations:
bearer
path Parameters
merchant_id
required
string
Request Body schema: application/json
required
code
required
string
name
required
string
description
required
string
contact_name
string
contact_email
string
contact_phone_number
string
website
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "contact_name": "string",
  • "contact_email": "string",
  • "contact_phone_number": "string",
  • "website": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Merchant by id

delete_merchant

Authorizations:
bearer
path Parameters
merchant_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get partner list for merchant

view_merchant

Authorizations:
bearer
path Parameters
merchant_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add partner to merchant

edit_merchant

Authorizations:
bearer
path Parameters
merchant_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to merchant

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach partner from merchant

edit_merchant

Authorizations:
bearer
path Parameters
merchant_id
required
string
query Parameters
partner_id
required
string

Partner Id that you want detach from merchant

Responses

Response samples

Content type
application/json
{ }

Get affiliate partners list for merchant

view_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add affiliate partner to merchant

edit_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
string
Request Body schema: application/json
required
partner_id
required
string

Affiliate Partner Id that you want attach to merchant

merchant_map_code
string or null <= 50 characters

The Partner Merchant Mapping Code, representing the merchant ID on the partner's side, is a required field for reward merchants

status
string
Enum: "Active" "Inactive"
is_reward
boolean
image_id
string
is_redemption
boolean
reward_processing_delay_days
integer [ 0 .. 30 ]
is_visible
boolean
discount
number
markup
number
object

Affiliate partner names

object

Affiliate partner descriptions

object

Affiliate partner OTP SMS templates

merchant_category_id
integer

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string",
  • "merchant_map_code": "string",
  • "status": "Active",
  • "is_reward": true,
  • "image_id": "string",
  • "is_redemption": true,
  • "reward_processing_delay_days": 0,
  • "is_visible": true,
  • "discount": 0,
  • "markup": 0,
  • "names": {
    },
  • "descriptions": {
    },
  • "otp_sms_templates": {
    },
  • "merchant_category_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get merchant affiliate partner

view_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update merchant affiliate partner

edit_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
string
partner_id
required
string
Request Body schema: application/json
required
merchant_map_code
string or null <= 50 characters

The Partner Merchant Mapping Code, representing the merchant ID on the partner's side, is a required field for reward merchants

status
required
string
Enum: "Active" "Inactive"
is_reward
boolean
image_id
string
is_redemption
boolean
reward_processing_delay_days
integer [ 0 .. 30 ]
is_visible
boolean
discount
number
markup
number
object

Affiliate partner names

object

Affiliate partner descriptions

object

Affiliate partner OTP SMS templates

merchant_category_id
integer

Responses

Request samples

Content type
application/json
{
  • "merchant_map_code": "string",
  • "status": "Active",
  • "is_reward": true,
  • "image_id": "string",
  • "is_redemption": true,
  • "reward_processing_delay_days": 0,
  • "is_visible": true,
  • "discount": 0,
  • "markup": 0,
  • "names": {
    },
  • "descriptions": {
    },
  • "otp_sms_templates": {
    },
  • "merchant_category_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete merchant affiliate partner

edit_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
string
query Parameters
partner_id
required
string

Affiliate Partner Id that you want to delete

Responses

Response samples

Content type
application/json
{ }

Get Merchant Stores

view_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add Merchant Store

edit_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
integer
Request Body schema: application/json
code
required
string
name
required
string
country_id
integer
area_id
integer
city_id
integer
lat
number
long
number

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "country_id": 0,
  • "area_id": 0,
  • "city_id": 0,
  • "lat": 0,
  • "long": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Merchant Store

view_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
integer
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Merchant Store

edit_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
integer
id
required
integer
Request Body schema: application/json
code
required
string
name
required
string
country_id
integer
area_id
integer
city_id
integer
lat
number
long
number

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "country_id": 0,
  • "area_id": 0,
  • "city_id": 0,
  • "lat": 0,
  • "long": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Merchant Store

edit_merchants

Authorizations:
bearer
path Parameters
merchant_id
required
integer
id
required
integer

Responses

Response samples

Content type
application/json
{ }

Get statuses for Merchant Affiliate Partner

view_merchants

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [ ]
}

Merchant Categories

List Merchant Categories

Retrieves a list of merchant categories optionally filtered by partner.

Authorizations:
bearer
query Parameters
id
integer

Filter by ID.

partner_id
integer

Filter by partner ID.

keyword
string

Filter by keyword.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Merchant Category

Creates a new merchant category with the given name and optional image.

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
description
string
required
object
web_image_id
integer
mobile_image_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "names": {
    },
  • "web_image_id": 0,
  • "mobile_image_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a Merchant Category

Retrieves details of a specific merchant category.

Authorizations:
bearer
path Parameters
merchant_category_id
required
integer

ID of the merchant category to retrieve.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a Merchant Category

Updates details of a specific merchant category.

Authorizations:
bearer
path Parameters
merchant_category_id
required
integer

ID of the merchant category to update.

Request Body schema: application/json
required
name
required
string
description
string
required
object
web_image_id
integer
mobile_image_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "names": {
    },
  • "web_image_id": 0,
  • "mobile_image_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a Merchant Category

Deletes a specific merchant category.

Authorizations:
bearer
path Parameters
merchant_category_id
required
integer

ID of the merchant category to delete.

Responses

Response samples

Content type
application/json
{ }

List Partners for a Merchant Category

Retrieves a list of partners associated with a specific merchant category.

Authorizations:
bearer
path Parameters
merchant_category_id
required
integer

ID of the merchant category.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach a Partner to a Merchant Category

Associates a partner with a specific merchant category.

Authorizations:
bearer
path Parameters
merchant_category_id
required
integer

ID of the merchant category.

Request Body schema: application/json
required
partner_id
required
string

Partner ID to attach to the merchant category

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach a Partner from a Merchant Category

Removes a partner from a specific merchant category.

Authorizations:
bearer
path Parameters
merchant_category_id
required
integer

ID of the merchant category.

Responses

Response samples

Content type
application/json
{ }

Member Notifications

List Member Notifications

Retrieves a list of member notifications based on the provided filters.

Authorizations:
bearer
query Parameters
notification_channel
string
Enum: "email" "sms"

Filter by channel of the member notification.

notification_type
string
Value: "user_registered"

Filter by notification type.

is_enabled
boolean

Filter by the enabled state of the event notification.

partner_ids
Array of integers

Filter by partner IDs.

order_by
string

Order by field.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create an Member Notification

Creates a new member notification with the provided details.

Authorizations:
bearer
Request Body schema: application/json
required
notification_channel
string
notification_type
string
is_enabled
required
boolean
send_at
string
partner_ids
required
Array of integers
required
Array of objects
Array of user_points_expiring (object) or Empty (object) (Member Notification Params)

Responses

Request samples

Content type
application/json
{
  • "notification_channel": "string",
  • "notification_type": "string",
  • "is_enabled": true,
  • "send_at": "string",
  • "partner_ids": [
    ],
  • "sms_templates": [
    ],
  • "params": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get an Member Notification

Retrieves details of a specific member notification.

Authorizations:
bearer
path Parameters
member_notification_id
required
integer

ID of the member notification to retrieve.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update an Member Notification

Updates details of a specific member notification.

Authorizations:
bearer
path Parameters
member_notification_id
required
integer

ID of the member notification to update.

Request Body schema: application/json
required
notification_channel
string
Enum: "email" "sms"
notification_type
string
Value: "user_registered"
is_enabled
required
boolean
send_at
string
partner_ids
required
Array of integers
required
Array of objects
Array of user_points_expiring (object) or Empty (object) (Member Notification Params)

Responses

Request samples

Content type
application/json
{
  • "notification_channel": "email",
  • "notification_type": "user_registered",
  • "is_enabled": true,
  • "send_at": "string",
  • "partner_ids": [
    ],
  • "sms_templates": [
    ],
  • "params": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete an Member Notification

Deletes a specific member notification.

Authorizations:
bearer
path Parameters
member_notification_id
required
integer

ID of the member notification to delete.

Responses

Response samples

Content type
application/json
{ }

List Partners for an Member Notification

Retrieves a list of partners associated with a specific member notification.

Authorizations:
bearer
path Parameters
member_notification_id
required
integer

ID of the member notification.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach a Partner to an Member Notification

Associates a partner with a specific member notification.

Authorizations:
bearer
path Parameters
member_notification_id
required
integer

ID of the member notification.

Request Body schema: application/json
required
partner_id
required
string

Partner Id that you want attach to event notification

Responses

Request samples

Content type
application/json
{
  • "partner_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Detach a Partner from an Member Notification

Removes a partner from a specific member notification.

Authorizations:
bearer
path Parameters
member_notification_id
required
integer

ID of the member notification.

Responses

Response samples

Content type
application/json
{ }

Get member notification placeholders

Returns placeholders for the specified member notification type.

Authorizations:
bearer
path Parameters
type
required
string
Value: "user_points_expiring"

The type of the member notification.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get member notification params schema

Returns params schema for the specified member notification type.

Authorizations:
bearer
path Parameters
type
required
string
Value: "user_registered"

The type of the member notification.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Maker Checker Requests

List Maker Checker Requests

Retrieves a list of maker checker requests based on the provided filters.

Authorizations:
bearer
query Parameters
type
string

Filter by type of the maker checker request.

status
integer
Enum: 0 1 2

Filter by status of the maker checker request. 0 - Pending, 1 - Approved, 2 - Rejected

manager_partner_id
integer

Filter by partner ID.

maker_id
integer

Filter by maker ID.

checker_id
integer

Filter by checker ID.

order_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Order by field.

per_page
integer

Number of results per page.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Maker Checker Request

Retrieves details of a specific maker checker request.

Authorizations:
bearer
path Parameters
request_id
required
integer

ID of the maker checker request to retrieve.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Approve Maker Checker Request

Approves a specific maker checker request.

Authorizations:
bearer
path Parameters
request_id
required
integer

ID of the maker checker request to approve.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reject Maker Checker Request

Rejects a specific maker checker request.

Authorizations:
bearer
path Parameters
request_id
required
integer

ID of the maker checker request to reject.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Trigger Manager

Get trigger campaigns list

Authorizations:
bearer
query Parameters
component_code
integer
Enum: 0 1

Filter by component ode

partner_ids
Array of integers

Filter by partners

frequency_ids
Array of integers

Filter by frequency types

is_active
integer
Enum: 0 1

Filter by active status

search_phrase
string

Filter by search phrase

order_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Order by

per_page
integer

Pagination size

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create trigger campaign

Authorizations:
bearer
Request Body schema: application/json
required
component_code
required
integer
Enum: 1 2
partner_id
required
integer
required
Array of objects
frequency_id
integer
Enum: 1 2 3 4 5

1 => one-time, 2 => daily, 3 => weekly, 4 => monthly, 5 => yearly. Optional: when omitted it defaults to one-time, i.e. a single action per member across the whole validity window.

icon_id
integer
icon_url
string

URL of the associated icon.

icon_color
string
created_date
required
string <date-time>
is_active
required
integer
Enum: 0 1
action_scope_type_id
required
integer
Enum: 1 2

1 => campaign_trigger, 2 => campaign

action_type_code
string

Action Type Code associated with the campaign.

period_validity_start
string or null <date>

Start date from which the campaign is valid.

period_validity_end
string or null <date>

End date until which the campaign is valid.

object or null

Condition type the campaign is built for, as selected in the Admin Panel. When sent, it must carry a condition that is a supported trigger condition code.

Responses

Request samples

Content type
application/json
{
  • "component_code": 1,
  • "partner_id": 0,
  • "names": [
    ],
  • "frequency_id": 1,
  • "icon_id": 0,
  • "icon_url": "string",
  • "icon_color": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "is_active": 0,
  • "action_scope_type_id": 1,
  • "action_type_code": "string",
  • "period_validity_start": "2019-08-24",
  • "period_validity_end": "2019-08-24",
  • "rule_definition": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get trigger campaign by id

Authorizations:
bearer
path Parameters
campaign_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update trigger campaign by id

Authorizations:
bearer
path Parameters
campaign_id
required
integer
Request Body schema: application/json
required
component_code
required
integer
Enum: 1 2
partner_id
required
integer
required
Array of objects
frequency_id
integer
Enum: 1 2 3 4 5

1 => one-time, 2 => daily, 3 => weekly, 4 => monthly, 5 => yearly. Optional: when omitted it defaults to one-time, i.e. a single action per member across the whole validity window.

icon_id
integer
icon_url
string

URL of the associated icon.

icon_color
string
created_date
required
string <date-time>
is_active
required
integer
Enum: 0 1
action_scope_type_id
required
integer
Enum: 1 2

1 => campaign_trigger, 2 => campaign

action_type_code
string

Action Type Code associated with the campaign.

period_validity_start
string or null <date>

Start date from which the campaign is valid.

period_validity_end
string or null <date>

End date until which the campaign is valid.

object or null

Condition type the campaign is built for, as selected in the Admin Panel. When sent, it must carry a condition that is a supported trigger condition code.

Responses

Request samples

Content type
application/json
{
  • "component_code": 1,
  • "partner_id": 0,
  • "names": [
    ],
  • "frequency_id": 1,
  • "icon_id": 0,
  • "icon_url": "string",
  • "icon_color": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "is_active": 0,
  • "action_scope_type_id": 1,
  • "action_type_code": "string",
  • "period_validity_start": "2019-08-24",
  • "period_validity_end": "2019-08-24",
  • "rule_definition": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete trigger campaign by id

Authorizations:
bearer
path Parameters
campaign_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Get items for a given campaign

Authorizations:
bearer
path Parameters
campaign_id
required
integer
query Parameters
search_phrase
string
order_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"
per_page
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create trigger item for a given campaign

A survey_completed condition must reference an existing Active or Paused survey of the campaign's partner; Draft, Completed and deleted surveys are rejected (422).

Authorizations:
bearer
path Parameters
campaign_id
required
integer
Request Body schema: application/json
required
id
integer
campaign_id
integer
required
Array of objects
Array of objects
rule
required
object
action_configuration
required
object
created_date
required
string <date-time>
is_active
required
boolean
allow_reversal
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "campaign_id": 0,
  • "names": [
    ],
  • "descriptions": [
    ],
  • "rule": { },
  • "action_configuration": { },
  • "created_date": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "allow_reversal": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get trigger item by id

Authorizations:
bearer
path Parameters
campaign_id
required
integer
item_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update trigger item by id

A survey_completed condition must reference an existing Active or Paused survey of the campaign's partner; Draft, Completed and deleted surveys are rejected (422).

Authorizations:
bearer
path Parameters
campaign_id
required
integer
item_id
required
integer
Request Body schema: application/json
required
id
integer
campaign_id
integer
required
Array of objects
Array of objects
rule
required
object
action_configuration
required
object
created_date
required
string <date-time>
is_active
required
boolean
allow_reversal
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "campaign_id": 0,
  • "names": [
    ],
  • "descriptions": [
    ],
  • "rule": { },
  • "action_configuration": { },
  • "created_date": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "allow_reversal": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete trigger item by id

Authorizations:
bearer
path Parameters
campaign_id
required
integer
item_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Transaction Processing

Process Transaction By Date

Authorizations:
bearer
Request Body schema: application/json
required
partner_ids
Array of integers
start_date
string
end_date
string
is_void
boolean

Responses

Request samples

Content type
application/json
{
  • "partner_ids": [
    ],
  • "start_date": "string",
  • "end_date": "string",
  • "is_void": true
}

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Get Process Transactions records amount

Authorizations:
bearer
Request Body schema: application/json
required
partner_ids
Array of integers
start_date
string
end_date
string

Responses

Request samples

Content type
application/json
{
  • "partner_ids": [
    ],
  • "start_date": "string",
  • "end_date": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Push Notifications

Get push notifications list

Authorizations:
bearer
query Parameters
search_phrase
string

Search by message and activity

is_sent
boolean

Filter by is_sent

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create push notification

Authorizations:
bearer
Request Body schema: application/json
required
push_time
required
string
activity
required
string
message
required
string
partner_id
required
integer
tier_ids
required
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "push_time": "string",
  • "activity": "string",
  • "message": "string",
  • "partner_id": 0,
  • "tier_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get push notification by id

Authorizations:
bearer
path Parameters
push_notification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update push notification by id

Authorizations:
bearer
path Parameters
push_notification_id
required
string
Request Body schema: application/json
required
push_time
string
activity
string
message
string
partner_id
integer
tier_ids
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "push_time": "string",
  • "activity": "string",
  • "message": "string",
  • "partner_id": 0,
  • "tier_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete push notification by id

Authorizations:
bearer
path Parameters
push_notification_id
required
string

Responses

Response samples

Content type
application/json
{ }

Dashboard

Get Rewarded and Redeemed Points for dashboard

view_pts_rewarded_redeemed

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Volume Overview for dashboard

view_volume_overview

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Member Accounts for dashboard

view_member_accounts

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Configs

Configs by partner and key

view_config

Authorizations:
bearer
query Parameters
partner_id
integer
config_key
string

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Update Configs

update_config

Authorizations:
bearer
Request Body schema: application/json
required
One of
partner_id
required
integer
config_key
required
string
cash_payment_allowed_over_cap
boolean
min_value
integer
period
string
Enum: "daily" "weekly" "monthly" "quarterly" "yearly"
cap_value
integer
discount_perc
integer
max_cash_perc
integer
Array of objects

Responses

Request samples

Content type
application/json
Example
{
  • "partner_id": 0,
  • "config_key": "string",
  • "cash_payment_allowed_over_cap": true,
  • "min_value": 0,
  • "period": "daily",
  • "cap_value": 0,
  • "discount_perc": 0,
  • "max_cash_perc": 0,
  • "trans_class_params": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Game Banners

Get Game Banners list

view_mobile_game_ads

Authorizations:
bearer
Request Body schema: application/json
required
partner_ids
Array of integers

Filter by partners

search_phrase
string

Search by title

Responses

Request samples

Content type
application/json
{
  • "partner_ids": [
    ],
  • "search_phrase": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Game Banner

create_mobile_game_ads

Authorizations:
bearer
Request Body schema: application/json
required
title
required
string
description
required
string
url
required
string <url>
partner_id
required
integer
image_id
integer

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "url": "string",
  • "partner_id": 0,
  • "image_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Game Banner by id

view_mobile_game_ads

Authorizations:
bearer
path Parameters
game_banner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Game Banner by id

edit_mobile_game_ads

Authorizations:
bearer
path Parameters
game_banner_id
required
integer
Request Body schema: application/json
required
title
required
string
description
required
string
url
required
string <url>
partner_id
required
integer
image_id
integer

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "url": "string",
  • "partner_id": 0,
  • "image_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Game Banner by id

delete_mobile_game_ads

Authorizations:
bearer
path Parameters
game_banner_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Shipping Companies

Get shipping company list

view_shipping_company

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Filter by partners

country_ids
Array of integers

Filter by countries

status
string
Enum: "active" "inactive"

Filter by customer status

search_phrase
string

Search by name or id (strict)

sort_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Sorting type for List

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create shipping company

add_shipping_company

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
description
string
country_id
integer
area_id
integer
city_id
integer
status
required
string
Enum: "active" "inactive"
contact_email
string
contact_name
string
contact_number
string
contact_website
string
address_1
string
address_2
string
image_id
integer or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "country_id": 0,
  • "area_id": 0,
  • "city_id": 0,
  • "status": "active",
  • "contact_email": "string",
  • "contact_name": "string",
  • "contact_number": "string",
  • "contact_website": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "image_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get shipping company by id

view_shipping_company

Authorizations:
bearer
path Parameters
shipping_company_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update shipping company by id

edit_shipping_company

Authorizations:
bearer
path Parameters
shipping_company_id
required
string
Request Body schema: application/json
required
name
required
string
description
string
country_id
integer
area_id
integer
city_id
integer
status
required
string
Enum: "active" "inactive"
contact_email
string
contact_name
string
contact_number
string
contact_website
string
address_1
string
address_2
string
image_id
integer or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "country_id": 0,
  • "area_id": 0,
  • "city_id": 0,
  • "status": "active",
  • "contact_email": "string",
  • "contact_name": "string",
  • "contact_number": "string",
  • "contact_website": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "image_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete shipping company by id

delete_shipping_company

Authorizations:
bearer
path Parameters
shipping_company_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get list of shipping company partners by id

Authorizations:
bearer
path Parameters
shipping_company_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach a partner to shipping company

Authorizations:
bearer
path Parameters
shipping_company_id
required
integer
partner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach a partner from shipping company

Authorizations:
bearer
path Parameters
shipping_company_id
required
integer
partner_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Suppliers

Get suppliers list

view_suppliers

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Filter by partners

category_ids
Array of integers

Filter by categories

country_ids
Array of integers

Filter by countries

status
string
Enum: "active" "inactive"

Filter by statuses

search_phrase
string

Search by name or id (strict)

sort_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Sorting type for List

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Supplier

create_suppliers

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
description
string
country_id
integer
area_id
integer
city_id
integer
status
required
string
Enum: "active" "inactive"
contact_email
string
contact_name
string
contact_number
string
contact_website
string
address_1
string
address_2
string
general_manager
string
marketing_manager
string
parent_id
integer
category_id
integer
voucher_type
string
Enum: "online" "offline"
image_id
integer
partner_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "country_id": 0,
  • "area_id": 0,
  • "city_id": 0,
  • "status": "active",
  • "contact_email": "string",
  • "contact_name": "string",
  • "contact_number": "string",
  • "contact_website": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "general_manager": "string",
  • "marketing_manager": "string",
  • "parent_id": 0,
  • "category_id": 0,
  • "voucher_type": "online",
  • "image_id": 0,
  • "partner_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get supplier by id

view_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update supplier by id

edit_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
string
Request Body schema: application/json
required
name
required
string
description
string
country_id
integer
area_id
integer
city_id
integer
status
required
string
Enum: "active" "inactive"
contact_email
string
contact_name
string
contact_number
string
contact_website
string
address_1
string
address_2
string
general_manager
string
marketing_manager
string
parent_id
integer
category_id
integer
voucher_type
string
Enum: "online" "offline"
image_id
integer
partner_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "country_id": 0,
  • "area_id": 0,
  • "city_id": 0,
  • "status": "active",
  • "contact_email": "string",
  • "contact_name": "string",
  • "contact_number": "string",
  • "contact_website": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "general_manager": "string",
  • "marketing_manager": "string",
  • "parent_id": 0,
  • "category_id": 0,
  • "voucher_type": "online",
  • "image_id": 0,
  • "partner_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete supplier by id

delete_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get supplier partners list

view_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach partner to supplier

edit_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
integer
partner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach partner from supplier

edit_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get supplier store location list

view_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Add supplier store location

edit_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
integer
Request Body schema: application/json
required
store_name
required
string
store_longitude
number
store_latitude
number
store_country_id
integer
store_area_id
integer
store_city_id
integer
store_street
string
store_floor
string
store_building
string

Responses

Request samples

Content type
application/json
{
  • "store_name": "string",
  • "store_longitude": 0,
  • "store_latitude": 0,
  • "store_country_id": 0,
  • "store_area_id": 0,
  • "store_city_id": 0,
  • "store_street": "string",
  • "store_floor": "string",
  • "store_building": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get supplier store and address

view_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
integer
store_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update supplier store and address

edit_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
integer
store_id
required
integer
Request Body schema: application/json
required
store_name
required
string
store_longitude
number
store_latitude
number
store_country_id
integer
store_area_id
integer
store_city_id
integer
store_street
string
store_floor
string
store_building
string

Responses

Request samples

Content type
application/json
{
  • "store_name": "string",
  • "store_longitude": 0,
  • "store_latitude": 0,
  • "store_country_id": 0,
  • "store_area_id": 0,
  • "store_city_id": 0,
  • "store_street": "string",
  • "store_floor": "string",
  • "store_building": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete supplier store with address

edit_suppliers

Authorizations:
bearer
path Parameters
supplier_id
required
integer
store_id
required
integer

Responses

Response samples

Content type
application/json
{ }

ISM

ISM order items list

view_ism_order_items

Authorizations:
bearer
Request Body schema: application/json
required
date_from
string <date>

Creation date from

date_to
string <date>

Creation date to

order_status
string
Enum: "created" "cancelled" "reversed"
partner_id
integer

Filter by partner ID

supplier_id
integer

Filter by supplier ID

batch_id
integer

Filter by export batch ID

approved
boolean

Filter by approval status

Responses

Request samples

Content type
application/json
{
  • "date_from": "2023-11-10",
  • "date_to": "2023-11-10",
  • "order_status": "created",
  • "partner_id": 0,
  • "supplier_id": 0,
  • "batch_id": 0,
  • "approved": true
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get order item values by id or code

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Change default order item values by id or code

edit_ism_order_default_values

Authorizations:
bearer
path Parameters
identifier
required
string
Request Body schema: application/json
required
default_supplier_id
string
default_item_cost
string
default_delivery_cost
string
default_item_cost_currency_code
string
default_delivery_cost_currency_code
string

Responses

Request samples

Content type
application/json
{
  • "default_supplier_id": "string",
  • "default_item_cost": "string",
  • "default_delivery_cost": "string",
  • "default_item_cost_currency_code": "string",
  • "default_delivery_cost_currency_code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ISM supplier order items list by order item ID or code

view_ism_supplier_order_items

Authorizations:
bearer
query Parameters
id
string
code
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ISM export supplier orders

export_ism_supplier_orders

Authorizations:
bearer
query Parameters
supplier_id
string
partner_id
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

ISM send supplier orders to supplier

send_ism_supplier_orders

Authorizations:
bearer
query Parameters
export_batch_id
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

ISM check existence of exported file

export_ism_supplier_orders

Authorizations:
bearer
query Parameters
export_batch_id
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ISM download exported file

export_ism_supplier_orders

Authorizations:
bearer
query Parameters
export_batch_id
string

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

ISM regenerate exported file

export_ism_supplier_orders

Authorizations:
bearer
query Parameters
export_batch_id
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

ISM reverse order item

reverse_ism_supplier_order

Authorizations:
bearer
query Parameters
id
string

Supplier Order Id

Request Body schema: application/json
required
item_code
string

Supplier Order Item Code

Responses

Request samples

Content type
application/json
{
  • "item_code": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

ISM change supplier order delivery cost

edit_ism_supplier_order

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
required
delivery_cost
string

Delivery Cost Amount

delivery_cost_currency_code
string

Delivery Cost Currency Code

Responses

Request samples

Content type
application/json
{
  • "delivery_cost": "string",
  • "delivery_cost_currency_code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ISM reverse supplier order item delivery

reverse_ism_supplier_order

Authorizations:
bearer
query Parameters
id
string

Supplier Order Id

Request Body schema: application/json
required
item_code
string

Supplier Order Item Code

Responses

Request samples

Content type
application/json
{
  • "item_code": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

ISM reconcile supplier order

reconcile_ism_supplier_order

Authorizations:
bearer
query Parameters
id
string

Supplier Order Id

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

ISM unreconcile supplier order

reconcile_ism_supplier_order

Authorizations:
bearer
query Parameters
id
string

Supplier Order Id

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get supplier order reconciliation list

Authorizations:
bearer
query Parameters
start_date
string <date>

Min value for order creation date

end_date
string <date>

Max value for order creation date

partner_id
string

Partner ID of item

supplier_id
string

Supplier ID of order

page
integer <int64>

Page number

per_page
integer <int64> [ 1 .. 100 ]

Number of records per page. Defaults to 15 when omitted.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ISM supplier order by ID

view_ism_supplier_orders

Authorizations:
bearer
path Parameters
order_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

ISM Create Supplier Order

create_ism_supplier_order

Authorizations:
bearer
Request Body schema: application/json
required
supplier_id
integer

Supplier Id

order_item_ids
Array of arrays

Order Item IDs

Responses

Request samples

Content type
application/json
{
  • "supplier_id": 0,
  • "order_item_ids": [ ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ISM supplier order by order or item code

view_ism_supplier_orders

Authorizations:
bearer
query Parameters
code
required
string
Example: code=KSA-O-1234567890123

19-character long code

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

ISM supplier order items list

view_ism_supplier_order_items

Authorizations:
bearer
path Parameters
order_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ISM add order items to supplier order

create_ism_supplier_order

Authorizations:
bearer
path Parameters
order_id
required
string
Request Body schema: application/json
required
order_item_ids
Array of arrays

Order Item IDs

Responses

Request samples

Content type
application/json
{
  • "order_item_ids": [ ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

ISM cancel items in supplier order

cancel_ism_supplier_order

Authorizations:
bearer
path Parameters
order_id
required
string
Request Body schema: application/json
required
supplier_order_item_ids
Array of arrays

Supplier Order Items IDs

Responses

Request samples

Content type
application/json
{
  • "supplier_order_item_ids": [ ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

ISM update supplier order item

edit_ism_supplier_order_item

Authorizations:
bearer
path Parameters
order_id
required
string

Supplier Order ID

id
required
string

Supplier Order Item ID

Request Body schema: application/json
required
sku
string

Supplier SKU code

item_cost
string

Item Cost Amount

item_cost_currency_code
string

Item Cost Currency Code

delivery_cost
string

Item Delivery Cost Amount

delivery_cost_currency_code
string

Item Delivery Cost Currency Code

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "item_cost": "string",
  • "item_cost_currency_code": "string",
  • "delivery_cost": "string",
  • "delivery_cost_currency_code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ISM order items selector

view_ism_order_items

Authorizations:
bearer
Request Body schema: application/json
required
delivery_detail_id
integer

Delivery Detail ID

partner_id
integer

Partner ID

Responses

Request samples

Content type
application/json
{
  • "delivery_detail_id": 0,
  • "partner_id": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ISM export batch list

view_ism_order_items

Authorizations:
bearer
query Parameters
date_from
string <date>
Example: date_from=2023-11-10

Creation date from

date_to
string <date>
Example: date_to=2023-11-10

Creation date to

supplier_id
integer

Supplier Id

partner_id
integer

Partner Id

file_name
string

file name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Supplier Delivery Config

view_ism_supplier_delivery_config

Authorizations:
bearer
path Parameters
supplier_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Supplier Delivery Config

edit_ism_supplier_delivery_config

Authorizations:
bearer
path Parameters
supplier_id
required
string
Request Body schema: application/json
required
delivery_calculation_type_code
required
string
Enum: "per_item" "per_order"

Delivery Calculation Type Code

Array of objects

Delivery cost details per country (Required if delivery_calculation_type_code is per_order)

Responses

Request samples

Content type
application/json
{
  • "delivery_calculation_type_code": "per_item",
  • "per_order_delivery_cost": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Supplier Delivery Config

create_ism_supplier_delivery_config

Authorizations:
bearer
Request Body schema: application/json
required
supplier_id
required
integer

Supplier Id

delivery_calculation_type_code
required
string
Enum: "per_item" "per_order"

Delivery Calculation Type Code

Array of objects

Delivery cost details per country (Required if delivery_calculation_type_code is per_order)

Responses

Request samples

Content type
application/json
{
  • "supplier_id": 0,
  • "delivery_calculation_type_code": "per_item",
  • "per_order_delivery_cost": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Templates

Get templates list

view_templates

Authorizations:
bearer
query Parameters
search_phrase
string

Search phrase

partner_ids
Array of integers

Filter by partner ids

per_page
integer

Number of items per page

order_by
string
Enum: "id_asc" "id_desc" "created_at_asc" "created_at_desc"

Order by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Template

create_templates

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
content
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get template by id

view_templates

Authorizations:
bearer
path Parameters
template_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update template by id

edit_templates

Authorizations:
bearer
path Parameters
template_id
required
string
Request Body schema: application/json
required
name
required
string
content
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete template by id

delete_templates

Authorizations:
bearer
path Parameters
template_id
required
string

Responses

Response samples

Content type
application/json
{ }

Clone template

create_templates

Authorizations:
bearer
path Parameters
template_id
required
string
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get template partners list

view_templates

Authorizations:
bearer
path Parameters
template_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach partner to template

edit_templates

Authorizations:
bearer
path Parameters
template_id
required
integer
partner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detach partner from template

edit_templates

Authorizations:
bearer
path Parameters
template_id
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{ }

Attach image to template

edit_templates

Authorizations:
bearer
path Parameters
template_id
required
integer
media_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete template image

edit_templates

Authorizations:
bearer
path Parameters
template_id
required
string
media_id
required
string

Responses

Response samples

Content type
application/json
{ }

Get template variables list

view_templates

Authorizations:
bearer
query Parameters
type
required
any

Type of template (notification,...)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Send test email

create_templates

Authorizations:
bearer
Request Body schema: application/json
required
type
required
string

Type of email (e.g. notification)

email
required
string

Receiver address

content
required
string

JSON with template content

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "email": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Import template

import_templates

Authorizations:
bearer
Request Body schema: application/json
required
html
required
string

Responses

Request samples

Content type
application/json
{
  • "html": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Languages

Get Languages list

view_languages

Authorizations:
bearer
Request Body schema: application/json
required
search_phrase
string

Search by name, short_code

Responses

Request samples

Content type
application/json
{
  • "search_phrase": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Language

create_languages

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
short_code
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Language by id

view_languages

Authorizations:
bearer
path Parameters
language_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Language by id

edit_languages

Authorizations:
bearer
path Parameters
language_id
required
integer
Request Body schema: application/json
required
name
string
short_code
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Language by id

delete_languages

Authorizations:
bearer
path Parameters
language_id
required
integer

Responses

Response samples

Content type
application/json
{ }

Rewarding Events

Get rewarding events list

view_rewarding_events

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

segment_ids
Array of arrays

Filter by segment or multiple segments

status
string
Enum: "Enabled" "Disabled"

Filter by status

name
string

Search by name

segment_name
string

Search by segment name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create rewarding event

create_rewarding_events

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
segment_id
required
string
status
required
string
Enum: "Enabled" "Disabled"
occurrence_frequency
required
string
Enum: "Daily" "Weekly" "Monthly" "Yearly"
no_repeating_days
required
string
valid_from
required
string
valid_to
required
string
sms_message
string
points_to_reward
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "segment_id": "string",
  • "status": "Enabled",
  • "occurrence_frequency": "Daily",
  • "no_repeating_days": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "sms_message": "string",
  • "points_to_reward": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get rewarding event by id

view_rewarding_events

Authorizations:
bearer
path Parameters
rewarding_event_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update rewarding event by id

edit_rewarding_events

Authorizations:
bearer
path Parameters
rewarding_event_id
required
string
Request Body schema: application/json
required
name
required
string
segment_id
required
string
status
required
string
Enum: "Enabled" "Disabled"
occurrence_frequency
required
string
Enum: "Daily" "Weekly" "Monthly" "Yearly"
no_repeating_days
required
string
valid_from
required
string
valid_to
required
string
sms_message
string
points_to_reward
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "segment_id": "string",
  • "status": "Enabled",
  • "occurrence_frequency": "Daily",
  • "no_repeating_days": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "sms_message": "string",
  • "points_to_reward": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete rewarding event by id

view_rewarding_events

Authorizations:
bearer
path Parameters
rewarding_event_id
required
string

Responses

Response samples

Content type
application/json
{ }

Rewarding Events Occurrence Frequencies

view_rewarding_events

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Tags

Get Tags list

view_tags

Authorizations:
bearer
Request Body schema: application/json
search_phrase
string

Filter by name

Responses

Request samples

Content type
application/json
{
  • "search_phrase": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Tag

create_tags

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Tag by id

view_tags

Authorizations:
bearer
path Parameters
tag_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Tag by id

edit_tags

Authorizations:
bearer
path Parameters
tag_id
required
string
Request Body schema: application/json
required
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Tag by id

delete_tags

Authorizations:
bearer
path Parameters
tag_id
required
string

Responses

Response samples

Content type
application/json
{ }

Import Transactions Files (Temporary for Legacy)

Get Import Transactions Files list (Temporary for Legacy)

view_uploaded_files

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Upload Import Transactions File (Temporary for Legacy)

create_uploaded_files

Authorizations:
bearer
Request Body schema: application/json
required
file
required
string <binary>
source_type_id
required
integer
pos_code
string

Responses

Request samples

Content type
application/json
{
  • "file": "string",
  • "source_type_id": 0,
  • "pos_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_date": "string",
  • "partner_name": "string",
  • "file_name": "string",
  • "admin_name": "string",
  • "error_file_url": "string"
}

Flow

Get flow by token

Sometimes you may need to get flow by access token

Authorizations:
bearer
header Parameters
X-Flow-Token
string

Responses

Response samples

Content type
application/json
{
  • "flow": {
    }
}

Create admin auth flow

Creates new admin auth flow with access token which can be used to go over flow's steps

Authorizations:
None
Request Body schema: application/json
required
login
required
string

admin account login identifier

password
required
string <password>

password

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "flow_token": "7364598720736459872073645987207364598720",
  • "flow": {
    }
}

Complete admin auth flow

Authenticate admin after passing admin auth flow

Authorizations:
None
header Parameters
X-Flow-Token
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Choose auth method

Choose auth method between Google 2FA or email OTP as a flow step

Authorizations:
None
header Parameters
X-Flow-Token
string
Request Body schema: application/json
required
method
required
integer

1 - Google 2FA, 2 - OTP

Responses

Request samples

Content type
application/json
{
  • "method": 0
}

Response samples

Content type
application/json
{
  • "flow_token": "7364598720736459872073645987207364598720",
  • "flow": {
    }
}

Get Google 2FA code

Get Google 2FA code in form of QR code and text secret

Authorizations:
None
header Parameters
X-Flow-Token
string

Responses

Response samples

Content type
application/json
{
  • "text_code": "string",
  • "qr_code": "string"
}

Provide 2FA code

Provide verification TOTP code from authenticator app

Authorizations:
None
header Parameters
X-Flow-Token
string
Request Body schema: application/json
required
code
required
string

TOTP code from authenticator app

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "flow_token": "7364598720736459872073645987207364598720",
  • "flow": {
    }
}

Send OTP to mobile

Send OTP(One Time Password) to mobile. First endpoint for "otp" flow step type

Authorizations:
None
header Parameters
X-Flow-Token
string

Responses

Response samples

Content type
application/json
{
  • "otp_token": "string",
  • "otp_attempts": "string",
  • "otp_token_expired_in_sec": "string",
  • "otp_template": "login"
}

Verify OTP

Verify OTP(One Time Password). You should use otp_token provided by send otp action. Second endpoint for "otp" flow step type

Authorizations:
None
header Parameters
X-Flow-Token
string
Request Body schema: application/json
required
otp_token
required
string

Otp token provided by send otp action

otp_value
string

Responses

Request samples

Content type
application/json
{
  • "otp_token": "string",
  • "otp_value": "string"
}

Response samples

Content type
application/json
{
  • "flow_token": "7364598720736459872073645987207364598720",
  • "flow": {
    }
}

Reset auth method

reset_auth_method

Authorizations:
bearer
path Parameters
admin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Marketplace Orders

Get marketplace orders list

Authorizations:
bearer
query Parameters
order_type_code
string
status_code
string
network_ids
Array of integers
partner_ids
Array of integers
search_term
string

Search by: order_id

placement_date_from
string <date>
Example: placement_date_from=2023-11-10

format Y-m-d

placement_date_to
string <date>
Example: placement_date_to=2023-11-10

format Y-m-d

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get marketplace order

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": {
    }
}

Reverse delivery of item order

Authorizations:
bearer
path Parameters
order_code
required
string

Responses

Response samples

Content type
application/json
{ }

Reverse Marketplace Item Order

Reverse Marketplace Item Order

Authorizations:
bearer
path Parameters
order_code
required
string

Order code on the platform side

Request Body schema: application/json
reason
any

Reason for reversion

Responses

Request samples

Content type
application/json
{
  • "reason": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Redemption Orders

Get redemption orders list

Authorizations:
bearer
query Parameters
network_ids
Array of integers
partner_ids
Array of integers
start_date
string <date>

Format Y-m-d

end_date
string <date>

Format Y-m-d

search_term
string

Search by: order_id

reference_number
string

Search by: reference_number

type_id
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get redemption order

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": {
    }
}

Reverse redemption order

reverse_redemption_order

Authorizations:
bearer
path Parameters
order_id
required
string

Responses

Response samples

Content type
application/json
{ }

Reverse redemption order items and delivery

reverse_redemption_order

Authorizations:
bearer
path Parameters
order_id
required
string
query Parameters
item_codes
Array of arrays
delivery_codes
Array of arrays

Responses

Response samples

Content type
application/json
{ }

Point Expiration

List Point Expiration Rules

Retrieves a list of point expiration rules based on the provided filters.

Authorizations:
bearer
query Parameters
is_active
integer
Enum: 1 0

Filter by status

partner_ids
Array of integers

Filter by partner IDs.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create a Point Expiration Rule

Creates a new point expiration rule with the provided details.

Authorizations:
bearer
Request Body schema: application/json
required
rule_name
required
string
rule_code
required
string

Unique identifier of the expiration rule. The reserved values default and no-expiry are not allowed and will be rejected with a 422 validation error.

period_value
required
integer
period
required
string
Enum: "DAY" "WEEK" "MONTH" "YEAR"
partner_id
required
integer
is_active
required
integer
Enum: 1 0

Responses

Request samples

Content type
application/json
{
  • "rule_name": "string",
  • "rule_code": "string",
  • "period_value": 0,
  • "period": "DAY",
  • "partner_id": 0,
  • "is_active": 1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a Point Expiration Rule

Retrieves details of a specific point expiration rule.

Authorizations:
bearer
path Parameters
point_expiration_rule_id
required
integer

ID of the point expiration rule to retrieve.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a Point Expiration Rule

Updates details of a specific point expiration rule.

Authorizations:
bearer
path Parameters
point_expiration_rule_id
required
integer

ID of the point expiration rule to update.

Request Body schema: application/json
required
rule_name
required
string
rule_code
required
string

Unique identifier of the expiration rule. The reserved values default and no-expiry are not allowed and will be rejected with a 422 validation error.

period_value
required
integer
period
required
string
Enum: "DAY" "WEEK" "MONTH" "YEAR"
partner_id
required
integer
is_active
required
integer
Enum: 1 0

Responses

Request samples

Content type
application/json
{
  • "rule_name": "string",
  • "rule_code": "string",
  • "period_value": 0,
  • "period": "DAY",
  • "partner_id": 0,
  • "is_active": 1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a Point Expiration Rule

Deletes a specific point expiration rule.

Authorizations:
bearer
path Parameters
point_expiration_rule_id
required
integer

ID of the point expiration rule to update.

Responses

Response samples

Content type
application/json
{ }

Calculate validity date

Calculate validity transaction date

Authorizations:
bearer
query Parameters
date
any

Transaction date

period
string
Enum: "DAY" "WEEK" "MONTH" "YEAR"

expiration period

period_value
integer

Period value

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Surveys

List surveys with filtering, search, and pagination

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Filter by partner IDs

status_ids
Array of integers

Filter by survey status IDs (1=Draft, 2=Active, 3=Paused, 4=Completed, 5=Scheduled)

search_phrase
string

Search by name

date_from
string <date>

Lower bound (Y-m-d) of the active-period overlap filter. Returns surveys whose active period (start_date..end_date) overlaps with the supplied range. Open-ended surveys (end_date is null) are included. Surveys with no start_date are excluded when this filter is used.

date_to
string <date>

Upper bound (Y-m-d) of the active-period overlap filter. Returns surveys whose active period (start_date..end_date) overlaps with the supplied range. Open-ended surveys (end_date is null) are included. Surveys with no start_date are excluded when this filter is used.

order_by
string
Enum: "created_at_asc" "created_at_desc" "id_asc" "id_desc"

Sorting type for list

per_page
integer >= 1

Pagination size

Responses

Response samples

Content type
application/json
{}

Create a new survey draft

Authorizations:
bearer
Request Body schema: application/json
required
partner_id
required
integer

Identifier of the partner associated with this survey.

reward_points
required
integer [ 0 .. 10000 ]

Reward points granted for completing the survey. 0 means the survey rewards nothing.

segment_ids
Array of integers or null

Ids of the segments to target. Recipients are the union of the selected segments' members. When omitted or empty, the survey targets all eligible (non-closed) customers of the partner.

notification_channel
required
integer

Notification channel enum value.

required
object

Translatable names keyed by language code. At least an English (en) entry is required. Each value is limited to 255 characters.

object or null

Translatable descriptions keyed by language code. Languages used must also exist in names. Each value is limited to 2000 characters.

required
Array of objects (survey-question)

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "reward_points": 0,
  • "segment_ids": [
    ],
  • "notification_channel": 0,
  • "names": {
    },
  • "descriptions": {
    },
  • "questions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieve detailed information for a specific survey

Authorizations:
bearer
path Parameters
id
required
integer

Survey ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a Draft survey (full content replacement)

Full content update for a survey in DRAFT status. Requires the same payload shape as creating a survey. Returns 422 if the survey is not in draft state — use PATCH /surveys/{id} for active/paused content edits, or POST /surveys/{id}/status for status transitions.

Authorizations:
bearer
path Parameters
id
required
integer

Survey ID

Request Body schema: application/json
required
partner_id
required
integer

Identifier of the partner associated with this survey.

reward_points
required
integer [ 0 .. 10000 ]

Reward points granted for completing the survey. 0 means the survey rewards nothing.

segment_ids
Array of integers or null

Ids of the segments to target. Recipients are the union of the selected segments' members. When omitted or empty, the survey targets all eligible (non-closed) customers of the partner.

notification_channel
required
integer

Notification channel enum value.

required
object

Translatable names keyed by language code. At least an English (en) entry is required. Each value is limited to 255 characters.

object or null

Translatable descriptions keyed by language code. Languages used must also exist in names. Each value is limited to 2000 characters.

required
Array of objects (survey-question)

Responses

Request samples

Content type
application/json
{
  • "partner_id": 0,
  • "reward_points": 0,
  • "segment_ids": [
    ],
  • "notification_channel": 0,
  • "names": {
    },
  • "descriptions": {
    },
  • "questions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Partial update for an Active or Paused survey

Partial update allowed only when the survey is in ACTIVE or PAUSED status. Returns 422 if the survey is in any other status.

Descriptions may always be changed. The start/end window may be changed only while the survey has not started — that is, while its start date is still in the future and no invitations have gone out. Once the start date is reached, start_date and end_date are read-only and sending either returns 422. Dates are day-only (YYYY-MM-DD).

Authorizations:
bearer
path Parameters
id
required
integer

Survey ID

Request Body schema: application/json
required
object or null

Translatable descriptions keyed by language code. Optional during active/paused updates. Each value is limited to 2000 characters.

start_date
string or null <date>

Optional new start date, day-only (YYYY-MM-DD). Accepted only while the survey has not started; once the stored start date is reached the field is rejected with 422. Must be tomorrow or later, and before the end date the survey ends up with.

end_date
string or null <date>

Optional new end date, day-only (YYYY-MM-DD). Accepted only while the survey has not started; once the stored start date is reached the field is rejected with 422. Must be after today and after the start date the survey ends up with — the one sent in the same request, or the stored one when start_date is omitted.

Responses

Request samples

Content type
application/json
{
  • "descriptions": {
    },
  • "start_date": "2026-08-01",
  • "end_date": "2026-08-31"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Remove a survey (restricted if responses exist)

Authorizations:
bearer
path Parameters
id
required
integer

Survey ID

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Transition a survey to a new status

Change the lifecycle status of a survey. Allowed transitions:

  • draft -> (no transitions; a draft survey is published through the publish endpoint)
  • scheduled -> paused, completed
  • active -> paused, completed
  • paused -> active, completed
  • completed -> (no transitions)

Returns 422 for disallowed transitions.

scheduled (5) is assigned by the platform and cannot be requested here; a request with status: 5 is rejected as a disallowed transition.

Requesting active on a survey whose start_date has not been reached stores scheduled rather than active, so a resumed survey does not re-enter the "active but not yet sent" state. The dispatch scheduler promotes it to active on the start date. Resuming a survey whose start_date has already passed stores active as before.

Activating a survey (transitioning to active) additionally requires the survey's end_date to be later than the current date — activating a survey whose end_date is in the past returns 422.

Authorizations:
bearer
path Parameters
id
required
integer

Survey ID

Request Body schema: application/json
required
status
required
integer
Enum: 1 2 3 4 5

New status value: 1=draft, 2=active, 3=paused, 4=completed, 5=scheduled.

Responses

Request samples

Content type
application/json
{
  • "status": 1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Publish a draft survey

Publish a draft survey: capture its active-window Start/End date-time and activate it. Only draft surveys can be published. Start must not be in the past and End must be after Start.

Authorizations:
bearer
path Parameters
survey_id
required
integer

Survey ID

Request Body schema: application/json
required
start_date
required
string <date-time>

Survey active-window start (date and time). Must not be in the past.

end_date
required
string <date-time>

Survey active-window end (date and time). Must be after start_date.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieve aggregated overview for a survey

Returns a survey overview report consisting of:

  • a summary banner with total responses, total invitations, opened and started counts, response rate and total points distributed;
  • a per-question breakdown with mean (for Rating Scale questions) and per-bucket counts/percentages.

Only completed responses contribute to the per-question breakdown, to total_responses and to the response rate. total_opened and total_started count the earlier lifecycle stages: the survey was loaded, and at least one question was answered.

Authorizations:
bearer
path Parameters
id
required
integer

Survey ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Export raw survey response answers as CSV

Streams a CSV file containing the raw per-answer rows for a survey, including both completed and in-progress responses. One row per answer; columns include survey, response, member, question and answer details, plus the response lifecycle timestamps: opened_at (the survey was loaded), started_at (the first question was answered) and submitted_at.

Authorizations:
bearer
path Parameters
id
required
integer

Survey ID

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Catalogs

Accor and children partner list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Product list catalog for Offline Vouchers report

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Filter by partner or multiple partners

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Static enumerations

Retrieves a list of static enumerations. Clients can specify which enums they wish to retrieve via a query parameter. It is recommended to cache the results on your side for efficient usage of this endpoint.

Authorizations:
bearer
query Parameters
enums
Array of strings
Items Enum: "sms_gateways" "member_notifications" "marketplace_order_statuses" "maker_checker_request_types" "maker_checker_request_statuses" "survey_statuses" "survey_question_types" "survey_notification_channels" "loyalty_rule_earning_types" "loyalty_rule_occurrence_policies" "loyalty_rule_occurrence_periods" "loyalty_rule_occurrence_scopes" "loyalty_rule_condition_types"

A list of enum keys to filter the results by. If omitted, all enums are returned.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Partner list catalog

Authorizations:
bearer
query Parameters
network_ids
Array of integers

Filter by network ids

network_id
string
Deprecated

Filter by network

country_id
string

Filter by country

area_id
string

Filter by area

city_id
string

Filter by city

member_id
string

Filter by member

with_disabled
boolean

Include disabled Partners in list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Supplier list catalog

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

status
string
Enum: "active" "inactive"

Filter suppliers by status

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Partner gateway list catalog

view_notifications

Authorizations:
bearer
query Parameters
network_id
string

Filter by network

with_disabled
boolean

Include disabled Partners in list

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Languages list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Localization Keys list catalog for new keys

edit_language_keys

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by name

partner_id
string

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Countries list catalog

Authorizations:
bearer
query Parameters
partner_id
string

Filter by partner

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Areas list catalog

Authorizations:
bearer
query Parameters
country_id
string

Filter by country

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Cities list catalog

Authorizations:
bearer
query Parameters
area_id
string

Filter by area

country_id
string

Filter by country

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Occupations list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Ticket types list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Tiers list catalog

Authorizations:
bearer
query Parameters
partner_id
integer
eligible_offer_id
integer

Get tiers allowed to be linked to the specified offer_id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Segments list catalog

Authorizations:
bearer
query Parameters
partner_id
string

Filter by partner

search_phrase
string
ids
Array of arrays

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Trigger campaigns list catalog

Authorizations:
bearer
query Parameters
partner_id
string

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Surveys list catalog

Lightweight, partner-scoped survey picker for the trigger-item rule builder (survey_completed condition). Returns only Active and Paused surveys — Draft, Completed, and deleted surveys are excluded so a reward cannot be attached to a finished survey. The full list is returned (no pagination), ordered by creation date descending (newest first).

Authorizations:
bearer
query Parameters
partner_id
string

Filter by partner

search_phrase
string

Filter by survey name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Roles list catalog

view_roles

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Admins list catalog

view_admins, view_maker_checker_request

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

with_disabled
boolean

Include disabled

partner_ids
Array of integers

Filter by partner or multiple partners

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Networks list catalog

List of networks sorted alphabetically

Authorizations:
bearer
query Parameters
member_id
integer

Filter by member

partner_ids
Array of integers

Filter by partner

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Balance types list

List of balance types sorted alphabetically

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Currencies list

Currencies list

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase based on name, short code

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Products catalog

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

partner_id
integer

Filter by partner

network_id
integer

Filter by network

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Product Types catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Top Partner Products catalog

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Reward Products catalog

Authorizations:
bearer
query Parameters
partner_id
string

Filter by partner

search_phrase
string

Filter by search phrase

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Redemption Products catalog

Authorizations:
bearer
query Parameters
partner_id
required
string

Filter by partner

network_id
required
integer

Filter by network

country_id
required
integer

Filter by redemption country

search_phrase
string

Filter by search phrase

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Partner Redemption Products catalog

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Brands catalog

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

POS Entry Modes catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

POS Environment Codes catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ECIs catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Product Categories catalog

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner

format_tree
boolean

Formating categories in a tree structure

with_trashed
boolean

Include trashed categories

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Stores catalog

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner

ignore_display_status
boolean

Ignore display status

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Merchant Catalog

Authorizations:
bearer
query Parameters
partner_id
string

Filter by partner, required with:is_reward, is_redemption parameters

with_disabled
boolean

Include disabled

is_reward
boolean
is_redemption
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Merchant categories catalog

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Merchant category codes catalog

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Transaction types catalog

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Partner bins catalog

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner

status
string
Enum: "Enrolled" "NotEnrolled"

Filter by status

search_phrase
string

Filter by search phrase

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Card Acceptors catalog

Authorizations:
bearer
query Parameters
search_phrase
string

Filter by search phrase

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Acquirer Bins catalog

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner

search_phrase
string

Filter by search phrase

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Reward Caps catalog

Authorizations:
bearer
query Parameters
partner_id
string

Filter by partner

accumulator_id
string

Filter the caps based on the specified accumulator type (points or money)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Accumulators catalog

(no accesses needed)

Authorizations:
bearer
query Parameters
partner_id
string
type_codes
Array of strings
Items Enum: "cap" "tier"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Reward Tiers catalog

Authorizations:
bearer
query Parameters
partner_id
string

Filter by partner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Loyalty programs list catalog

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Members list catalog

view_tickets || view_notifications

Authorizations:
bearer
query Parameters
search
any

Filter by search phrase

field
string
Enum: "id" "reference" "partner_user_code" "ucid" "username" "email" "mobile" "full_name"

Specifies the target field

partner_ids
Array of arrays

Filter by partner or multiple partners

network_ids
Array of arrays

Filter by network or multiple networks

card_bin
any

Filter by card number bin

card_last_4
any

Filter by card number last 4 digit

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Affiliates catalog

Authorizations:
bearer
query Parameters
status
string
Enum: "enabled" "disabled"
with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Affiliate program categories catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Membershiptiers list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Reward Types list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Cuisines list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Affiliate programs catalog

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Affiliate programs catalog

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Audit trail actions list catalog

Authorizations:
bearer
query Parameters
type
string

Filter by type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get partner categories catalog

Authorizations:
bearer
query Parameters
partner_ids
Array of arrays

Filter by partner or multiple partners

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get offers list

Authorizations:
bearer
query Parameters
with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get display channel offers list

Authorizations:
bearer
query Parameters
with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Tier Criteria list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Shipping Companies catalog list

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner

with_disabled
boolean

Include disabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Upload Files Types list catalog

view_uploaded_files

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Upload Files Source list catalog

view_uploaded_files

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Redemption Trans Classes catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Order Types

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Report schedule frequency list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Report schedule days list catalog

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Email templates list

Authorizations:
bearer
query Parameters
partner_ids
Array of integers

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Email template variables list

Authorizations:
bearer
query Parameters
type
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Tags list

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Badge icons list

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Point Expiration Rule list catalog

Authorizations:
bearer
query Parameters
partner_id
required
integer

Filter by partner IDs

is_active
boolean

When true, returns only the partner's active rules. Omit the parameter to return every rule of the partner.

network_id
integer

Optional. Selects which of the partner's networks decides the default rule flagged by is_default. It does not change which rules are returned. Must be a network the partner belongs to, otherwise the request is rejected with 422. When omitted the default is resolved from the partner's network membership the same way the partner profile resolves it.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Media

Upload image

Authorizations:
bearer
Request Body schema: multipart/form-data
required
image
required
string <binary>

Image to upload

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Upload image by URL

Authorizations:
bearer
Request Body schema: multipart/form-data
required
image
string

Image URL to upload

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update image original name

Authorizations:
bearer
path Parameters
media_id
required
integer
Request Body schema: multipart/form-data
required
original_name
required
string

New original name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Badge Icons

Get Badge Icons

Authorizations:
bearer
query Parameters
is_active
integer
Enum: 0 1

Filter by active status (1 active, 0 inactive)

search_phrase
string

Filter by name

per_page
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Upload Badge Icon

Authorizations:
bearer
Request Body schema: multipart/form-data
required
original_name
required
string

Original filename to store

image
required
string <binary>

Image file to upload (svg or png)

is_active
required
integer
Enum: 0 1

Whether the icon should be active (1) or inactive (0)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Badge Icon

Authorizations:
bearer
path Parameters
icon_id
required
integer

Icon ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Badge Icon

Authorizations:
bearer
path Parameters
icon_id
required
integer

Icon ID

Request Body schema: multipart/form-data
required
original_name
required
string

Original filename to store

image
string <binary>

Image file to upload (svg or png). Optional; if omitted, only metadata is updated

is_active
required
integer
Enum: 0 1

Whether the icon should be active (1) or inactive (0)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

ETL Processes

Get process status

getEtlProcess

Authorizations:
bearer
path Parameters
process_id
required
integer
query Parameters
signature
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "urls": {
    }
}

List pre-generated records

Authorizations:
bearer
path Parameters
process_id
required
integer

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ],
  • "totals": {
    }
}

Export records as .csv

Authorizations:
bearer
path Parameters
process_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

Saga Monitoring

Get saga process list

view_saga_process

Authorizations:
bearer
Request Body schema: application/json
required
saga_code
string

Search by saga code

status
string
Enum: "processing" "sleeping" "expecting" "erroneous" "fail" "expectation_taken"

Filter by status

Responses

Request samples

Content type
application/json
{
  • "saga_code": "string",
  • "status": "processing"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get saga process info

view_saga_process

Authorizations:
bearer
path Parameters
process_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retry failed saga process

retry_failed_saga_process

Authorizations:
bearer
path Parameters
process_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Revert failed saga process

revert_failed_saga_process

Authorizations:
bearer
path Parameters
process_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Webhooks

Get webhooks list

Authorizations:
bearer
query Parameters
partner_id
integer

Filter by partner ID

per_page
integer >= 1
Default: 15

Number of items per page

Responses

Response samples

Content type
application/json
{}

Create a new webhook

Authorizations:
bearer
Request Body schema: application/json
required
partner_id
required
integer

Partner ID

title
required
string [ 2 .. 255 ] characters

Webhook title

url
required
string <uri> <= 500 characters

Webhook URL

secret
required
string [ 8 .. 255 ] characters

Secret key for webhook authentication

verify_ssl
required
integer
Enum: 0 1

Whether to verify SSL certificate (0 or 1)

events
required
Array of integers non-empty [ items >= 1 ]

Array of event type IDs

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get webhook by ID

Authorizations:
bearer
path Parameters
id
required
integer

Webhook ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
bearer
path Parameters
id
required
integer

Webhook ID

Request Body schema: application/json
required
title
required
string [ 2 .. 255 ] characters

Webhook title

url
required
string <uri> <= 500 characters

Webhook URL

secret
string [ 8 .. 100 ] characters

Secret key for webhook authentication

verify_ssl
required
integer
Enum: 0 1

Whether to verify SSL certificate (0 or 1)

events
required
Array of integers non-empty [ items >= 1 ]

Array of event type IDs

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
bearer
path Parameters
id
required
integer

Webhook ID

Responses

Response samples

Content type
application/json
{
  • "message": "Bearer token is invalid"
}

List webhook requests

Authorizations:
bearer
path Parameters
id
required
integer

Webhook ID

query Parameters
status
integer
Example: status=3

Filter by request status (1=Initiated, 2=Pending, 3=Processing, 4=Failed, 5=Succeeded)

per_page
integer >= 1
Default: 15
Example: per_page=15

Number of items per page

Responses

Response samples

Content type
application/json
{}