Authentication and credentials
Your API credentials come from your system admin.
With user access and authentication credentials, you can start to use the Checkout.
Get your credentials
| Variable | Where to find it | Example |
|---|---|---|
CHECKOUT_URL | Provided by your account manager | https://BASE_URL.example.com |
PAYMENT_URL | Provided by your account manager | https://API.BASE_URL.example.com |
merchant_key | Admin panel → Merchants → your merchant → Test key | 27106696-656c-...-7e11ae873370 |
password | Admin panel → Merchants → your merchant → Password | 2fc46f1f...bd45th |
Authenticate
Two endpoints are available, one per integration type.
- Use the Checkout endpoint for Checkout integrations
- Use the S2S endpoint for S2S Card or S2S APM integrations.
Checkout
Creates a hosted payment session. The platform returns a redirect_url that you send the customer to.
POST {CHECKOUT_URL}/api/v1/session
Header: Content-Type: application/json
S2S (Card and APM)
Entry point for all S2S transactions (SALE, CAPTURE, VOID, and others). The request body is form-encoded (key=value pairs), not JSON.
POST {PAYMENT_URL}/post
Header: Content-Type: application/x-www-form-urlencoded
Set your callback URL
Your callback_url is the endpoint on your server where Payment Platform sends payment result callbacks.
- Checkout: configured by a system admin in the admin panel. It is not available per request. See Checkout callbacks.
- S2S (Card and APM): configured in the admin panel as
notification_url. You can also sendcallback_urlin a payment request, for exampleSALE, to replace it for all callbacks of that payment. See S2S CARD callbacks and S2S APM callbacks.
Your system admin also sets up your user access to the admin dashboard and transaction history.
tipPer-request
callback_urlis available only for S2S protocols.