Accept payment

post https://{project_url}/webservice/rest-api/{api_interface}/{version}/purchases/actions/accept-payment

The method processes bill closure requests. CareCloud returns information about discounts, applied vouchers, and points used for payment that change the bill's final price.

Body Params

store_id

string

required

ID of the store.

cashdesk_number

integer

required

Number of the cash-desk in the store.

card_number

string

The customer card number.

customer_id

string

ID of the customer that made the purchase. You can search customers by plenty parameter in resource customers.

payment_type

string

required

Payment type changes the checkout process depending on the value of the parameter you can allow/deny the use of benefits.
Possible values are: "S" - with standard setup checkout process allows you to collect points, but isn't possible to apply overall discounts / "A"- checkout process allows you to collect points and apply overall discounts too / "C" - use credits for payment, allows you to collect points, but isn't possible to apply overall discounts / "D"- will enable you to use overall discounts, but you are not able to collect points with this setup.

max_points

float

Amount of points to be redeemed.

max_credit

float

Amount of credit customer wants to use in the purchase.

benefit_codes

array of strings

The bill closure will use present codes and recommend discounts.

benefit_codes

bill

object

required

Structure of bill from POS.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

The structure contains values for applied rewards, vouchers, discounts, and other benefits.

recommended_discounts

array of objects

The list of offered discounts excludes rewards (Loyalty Status Discount).

recommended_discounts

object

discount_code

string

Code of discount (set value “offline” for offline mode discounts).

discount_value

float

Value of discount in the currency of the bill.

discount_percent

float

Discount percentage of the bill.

description

string

Text description of the discount reason.

bill_item_id

string

required

ID of the related bill item.

credit_points

float

Amount of used points.

price_of_credit_points

float

Amount of money corresponding to the number of used points.

credit

float

Amount of used credits.

vouchers

array of objects

List of applied rewards/vouchers on the current bill (includes the value of discount) independent of DiscountItem.

vouchers

object

code

string

Code of a reward or a voucher used in the purchase.

name

string

Name of the reward.

discount_value

float

Value of discount in the currency of the purchase.

discount_percent

float

Value of discount in percent.

bill_item_id

string

ID of the related bill item.

credit_points_of_this_transaction

float

Sum of points gained from this transaction.

total_credit_points

float

Amount of the points on the customer account (after the recent purchase is closed).

total_credit

float

Amount of the credits on the customer account (after the recent purchase is closed).

messages

array of objects

A recommendation messages for the cashier in his language localization.

messages

object

text

string

Text of the message.

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 POST \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/purchases/actions/accept-payment \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '{"payment_type":"S"}'


xxxxxxxxxx
33
}
1
{
2
  "data": {
3
    "recommended_discounts": [
4
      {
5
        "discount_code": null,
6
        "discount_value": null,
7
        "discount_percent": null,
8
        "description": null,
9
        "bill_item_id": "6fd73167342d6899c415320"
10
      }
11
    ],
12
    "credit_points": 0,
13
    "price_of_credit_points": 0,
14
    "credit": 0,
15
    "vouchers": [
16
      {
17
        "code": "PTV123",
18
        "name": "10% off your first purchase",
19
        "discount_value": 70,
20
        "discount_percent": 10,
21
        "bill_item_id": "6fd73167342d6899c415320"
22
      }
23
    ],
24
    "credit_points_of_this_transaction": 0,
25
    "total_credit_points": 0,

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.