BOPAY API
API for accepting payments and payouts.
Getting Started
To work with the API you need a merchant account. Contact your manager — they will create an account and grant access to the dashboard.
In the dashboard, create a terminal. Each terminal has its own key pair:
- API Key — terminal identifier. Passed in the
X-Identityheader. - Secret Key — the merchant key used to sign requests. One for all terminals. Found in the "Settings" section.
caution
Never share your Secret Key with third parties or expose it publicly.
Request Format
Base URL:
https://api.bopay.io/v1
Every request must contain the headers:
| Header | Description |
|---|---|
X-Identity | Terminal API Key |
X-Signature | Request signature (HMAC-SHA1, Base64) |
Content-Type | application/json for most requests, multipart/form-data when uploading files or forms |
Signature details are in the Authorization section.