Documentation

API Access per scope

Foxorder's API contains diffrents roles. Each endpoint is restricted for one or multiple roles depending on its need.

If you would like to test these endpoints in our Swagger UI docs, you need to retrieve a JWT token first.

Here are the roles available in our API:

SCOPE MANAGERThe manager of the franchise

SCOPE SHOP_OWNERThe manager of the shop

SCOPE FRONTFranchise's online shop

SCOPE CUSTOMERThe customer

Endpoint	Method	Description	FRONT	MANAGER	SHOP_OWNER	CUSTOMER
/api/v2/payments/create	POST	Create a payment	Authorized	Unauthorised	Unauthorised	Authorized
/api/v2/payments/result	POST	Handle payment result	Authorized	Unauthorised	Unauthorised	Authorized
/api/v2/payments/{external_id}/status	GET	Get payment status by external id	Authorized	Unauthorised	Unauthorised	Unauthorised
/api/v2/payments/{id}/payplug-apple-pay/complete	PATCH	Complete Apple Pay payment	Authorized	Unauthorised	Unauthorised	Authorized