API reference

Payments API

The current version of the API supports the following payment providers:

  • BENEFIT
  • MASTERCARD

Available Endpoints

EndpointDescription
/initiate-paymentInitiate a new payment transaction
/payment-statusCheck the status of a previously initiated payment
/refund-paymentRequest a refund for a successful transaction

Authentication

All requests must be authenticated using an API key passed in the Authorization header:

Authorization: YOUR_API_KEY

🔐 Make sure to keep your API keys secure and never expose them in client-side code or logs.

Common Response Structure

Most responses follow this general structure:

{
  "status": "success",
  "track_id": "TRACK_7890"
}

*Or in case of errors:

{
  "detail": "Error message here"
}

Each endpoint may return additional fields depending on the operation performed.

Supported Payment Providers

You can specify which payment provider to use when initiating a payment. The supported values are:

  • BENEFIT
  • MASTERCARD

Make sure that your merchant account has the necessary credentials configured for the selected provider.