bePaid has a REST-ful API. To accept payments you need to send requests of a format specified for each transaction type and endpoint. However, regardless the type, each request to bePaid API must meet the following requirements:
- Use HTTP Basic authentication with Shop ID and Secret Key as a username and a password respectively;
- Add the
- Make a JSON-serialized body;
- Use the UTF-8 encoding.
Mandatory request parameters are labeled as * required. Non-labeled parameters are considered optional.
As of September 15, 2022, the API v.3 is already configured for all
https://gateway.bepaid.by/ - endpoints. To submit requests to this API version, just add the
X-API-Version: 3 header to the request. For response parameters and their description, please use the API version 3 guide.