API Reference

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

ID of the store.

integer
required

Number of the cash-desk in the store.

string

The customer card number.

string

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

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:
float

Amount of points to be redeemed.

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
string
Defaults to cs, en-gb;q=0.8

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

Responses

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.

Updated over 2 years ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago