Return payment summary

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/purchases/{purchase_id}/actions/payment-summary

Action method shows credit, point and voucher summary of a purchase.

Responses

Response body

object

data

object

earned_points

float

Amount of earned points of the purchase.

used_credits

float

Amount of credits used to pay of the purchase.

used_points

float

Amount of points used to pay of the purchase.

used_points_total

float

Amount of points used to pay and used in vouchers of the purchase.

used_vouchers

array of objects

List of used vouchers.

used_vouchers

object

voucher_id

string

The unique ID of the voucher.

customer_id

string

required

The unique ID of the customer.

store_id

string

The unique ID of the store where voucher was applied.

code

string

Code of the voucher.

value

float

Value of the voucher when applied by the purchase.

applied_date

string

Voucher application date. (YYYY-MM-DD HH:MM:SS)

valid_from

string

Date from the voucher is valid. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Date to the voucher is valid. (YYYY-MM-DD HH:MM:SS)

reward_group

string

The unique ID of the reward group.

note

string

Voucher's note.

reward

object

Reward structure.

created_at

string

Date of the voucher creation. (YYYY-MM-DD HH:MM:SS)

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the voucher.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/purchases/purchase_id/actions/payment-summary \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
134
}
1
{
2
  "data": {
3
    "earned_points": 376,
4
    "used_credits": 0,
5
    "used_points": 0,
6
    "used_points_total": 0,
7
    "used_vouchers": [
8
      {
9
        "voucher_id": "8bb7345976bbc9ed20e5083dd6",
10
        "customer_id": "81ceb8582e2d8dbb7e71b7273b",
11
        "store_id": "86e05affc7a7abefcd513ab400",
12
        "code": "w7TU7KfeE",
13
        "value": 3.49,
14
        "applied_date": "2013-07-24 21:33:13",
15
        "valid_from": "2013-07-10 21:33:13",
16
        "valid_to": "2013-07-30 21:33:13",
17
        "reward_group": "83cfee22eabfbbb15a14815e30",
18
        "note": "Contact before use",
19
        "reward": {
20
          "reward_id": "83cfee22eabfbbb15a14815e30",
21
          "code": null,
22
          "name": "Dessert+Caffe",
23
          "note": "",
24
          "subtitle": null,
25
          "points_cost": 200,

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.