Accept payment

post

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

Calculate the applicable discounts, vouchers, and points for a bill before it is finalised. The response contains the recommendations the cashier can present to the customer; it does not commit the purchase.

What happens when accept-payment is called

CareCloud evaluates the supplied bill items against the customer's eligible benefits (vouchers, discounts, point payment).
The response contains recommended_discounts, vouchers, credit_points, and related fields the cashier can apply.
No purchase record is created and no benefits are consumed by this call. To finalise the bill, call POST /purchases/actions/send-purchase afterwards.

Related operations

POST /purchases/actions/recommend-best-rewards - get the list of best-fit rewards for a bill before deciding which to apply.
POST /purchases/actions/send-purchase - finalise the bill after the customer accepts the calculated payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

enum

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.

Allowed:

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

length ≤ 1000

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

`error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The request path does not match any API route, or the addressed resource does not exist.

405The request path matches a valid route, but the endpoint does not support the HTTP method used in the request.

500Server is not working as expected.