API Endpoints

Complete reference for all payment gateway API endpoints.

Endpoint Categories

Payment Applications

Manage your payment applications and their configuration.

Payments & Checkout

Create and manage payment requests, plus public checkout endpoints.

Authentication

Endpoints use two authentication methods:

  • OAuth2 Token — for dashboard operations (managing applications, viewing payments)
  • Client Token — for server-to-server calls (creating payments, fetching status)
Authorization: Bearer YOUR_TOKEN

See the Authentication guide for details on token types and scopes.

Response Format

All responses follow a consistent JSON structure:

Success Response

{
  "data": {
    // Response data
  }
}

Error Response

{
  "message": "Error description"
}

Validation errors return a 422 status with field-specific messages:

{
  "message": "The given data was invalid.",
  "errors": {
    "amount": ["The amount field is required."],
    "currencyCode": ["The currency code field is required."]
  }
}

Next Steps