Wallet API (1.0)

Download OpenAPI specification:Download

OrderingStack wallet API

Authentication

oauth2

Standard token auth

Security Scheme Type	OAuth2

oauth2-client

Internal authorization between microservices

Security Scheme Type	OAuth2

wallet

getWallet

Get wallet for specific user. If it is not created - get 404.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

path Parameters

wallet

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Responses

putWallet

Update wallet for logged user. If wallet was not there - it is created.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

path Parameters

wallet

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

property name*

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

postWallet

Create wallet for specific user. If wallet is already there - attributes are overwritten if they are provided and not empty.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

path Parameters

wallet

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

property name*

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

x-tenant

string <uuid>

Responses

rewards

getReward

Get reward by id.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_REWARDS)

path Parameters

reward

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Responses

updateReward

Update reward by id.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_REWARDS)

path Parameters

reward

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

code	string [ 1 .. 32 ] characters
name required	string [ 3 .. 128 ] characters [\p{L}\p{N}_. -]+
visible	boolean Visible in catalog and allowed to exchange for points by users themselves
	object (Details)
availableFrom	string <date-time>
availableTo	string <date-time>
points required	number > 0
maxCount	integer <int32> >= 1
priority	integer <int32> >= 0
product required	string
productConfig	object
tags	Array of strings
	object

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"visible": true,
"details": {"literals": {"property1": "string",
"property2": "string"
},
"media": [{"url": "string",
"name": "string"
}
]
},
"availableFrom": "2019-08-24T14:15:22Z",
"availableTo": "2019-08-24T14:15:22Z",
"points": 0,
"maxCount": 1,
"priority": 0,
"product": "string",
"productConfig": { },
"tags": ["string"
],
"extra": {"property1": "string",
"property2": "string"
}
}

deleteReward

Delete reward by id.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_REWARDS)

path Parameters

reward

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Responses

insertReward

Insert reward by id.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_REWARDS)

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

code	string [ 1 .. 32 ] characters
name required	string [ 3 .. 128 ] characters [\p{L}\p{N}_. -]+
visible	boolean Visible in catalog and allowed to exchange for points by users themselves
	object (Details)
availableFrom	string <date-time>
availableTo	string <date-time>
points required	number > 0
maxCount	integer <int32> >= 1
priority	integer <int32> >= 0
product required	string
productConfig	object
tags	Array of strings
	object

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"visible": true,
"details": {"literals": {"property1": "string",
"property2": "string"
},
"media": [{"url": "string",
"name": "string"
}
]
},
"availableFrom": "2019-08-24T14:15:22Z",
"availableTo": "2019-08-24T14:15:22Z",
"points": 0,
"maxCount": 1,
"priority": 0,
"product": "string",
"productConfig": { },
"tags": ["string"
],
"extra": {"property1": "string",
"property2": "string"
}
}

getRewards

Get rewards (supports pagination).

Authorizations:

oauth2

query Parameters

required

object (RewardsFilter)

header Parameters

x-tenant

string <uuid>

Responses

voucher

useVoucher

Use voucher on specific wallet

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLETROLE_WALLET_VOUCHER)

path Parameters

wallet

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

voucher

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"voucher": "f54d9d74-3755-45a8-b042-f5b2aefca818"
}

useVoucherOnMyWallet

Use voucher on logged user wallet

Authorizations:

oauth2

Request Body schema: application/json

voucher

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"voucher": "f54d9d74-3755-45a8-b042-f5b2aefca818"
}

useVoucherOnMyWallet_1

Use voucher on logged user wallet

Authorizations:

oauth2

Request Body schema: application/json

voucher

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"voucher": "f54d9d74-3755-45a8-b042-f5b2aefca818"
}

createVoucher

Create new voucher. Expiration date for voucher can be provided (it also applies to batch of points from that voucher). Additionaly points can last for specified number of days after voucher usage.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLETROLE_WALLET_VOUCHER)

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

amount required	number > 0
price	number > 0
expires	string <date-time>
pointsExpireInDays	integer <int32> >= 1
forWallet	string <uuid>
	object

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"price": 0,
"expires": "2019-08-24T14:15:22Z",
"pointsExpireInDays": 1,
"forWallet": "1c596f49-6bbe-43f6-a405-e2f35389a324",
"extra": {"property1": "string",
"property2": "string"
}
}

getVoucher

Get voucher details.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLETROLE_WALLET_VOUCHER)

path Parameters

voucher

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Responses

vouchers

Vouchers in period.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

query Parameters

from required	string <date-time>
to required	string <date-time>

header Parameters

x-tenant

string <uuid>

Responses

operation

addOperation

New operation (usage of collected points)

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLETROLE_WALLET_OP)

path Parameters

wallet

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

amount required	number > 0
order	string [ 0 .. 64 ] characters
	object

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"order": "string",
"extra": {"property1": "string",
"property2": "string"
}
}

rollbackOperation

Operation rollback (points are returned to batches they were collected from).

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLETROLE_WALLET_OP)

path Parameters

wallet

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

string <uuid>

Responses

Request samples

Payload

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

batch

addBatch

Create and add new batch of points. Batch can have expiration date and price for which points were bought..

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLETROLE_WALLET_BATCH)

path Parameters

wallet

required

string <uuid>

header Parameters

x-tenant

string <uuid>

Request Body schema: application/json

amount required	number > 0
price	number > 0
expires	string <date-time>
order	string [ 0 .. 64 ] characters
	object

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"price": 0,
"expires": "2019-08-24T14:15:22Z",
"order": "string",
"extra": {"property1": "string",
"property2": "string"
}
}

expiringPoints

Points expiring in near future.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

query Parameters

to

required

string <date-time>

header Parameters

x-tenant

string <uuid>

Responses

expiredPaidBatches

Expired paid batches in period.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

query Parameters

from required	string <date-time>
to required	string <date-time>

header Parameters

x-tenant

string <uuid>

Responses

report

walletsReport

Wallets report.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

header Parameters

x-tenant

string <uuid>

Responses

vouchers

Vouchers in period.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

query Parameters

from required	string <date-time>
to required	string <date-time>

header Parameters

x-tenant

string <uuid>

Responses

expiringPoints

Points expiring in near future.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

query Parameters

to

required

string <date-time>

header Parameters

x-tenant

string <uuid>

Responses

expiredPaidBatches

Expired paid batches in period.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

query Parameters

from required	string <date-time>
to required	string <date-time>

header Parameters

x-tenant

string <uuid>

Responses

getAggregatedReport

Get aggregated report. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:

oauth2-clientoauth2 (ROLE_SUROLE_WALLET)

query Parameters

required

object (AggregateFilter)

Responses

user

getMyOperations

Get operations for my wallet. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:

oauth2

query Parameters

required

object (MyOperationsFilter)

Responses

getMyBatches

Get active batches for my wallet. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:

oauth2

query Parameters

required

object (MyBatchesFilter)