API Reference

OpenAPI Specification

Download our OpenAPI specification to generate client libraries or import into API tools like Postman.Download OpenAPI (JSON)

Full Documentation

Download the complete documentation as a text file for offline reading or AI tool integration.Download Docs (TXT)

API Endpoints

Environment	Base URL
Sandbox	`https://api.sandbox.zafapay.com`
Production	`https://api.zafapay.com`

Authentication

All API requests require Bearer token authentication.

Authorization: Bearer YOUR_ACCESS_TOKEN

For instructions on obtaining an access token, see Authentication.

Request Format

Content-Type: application/json
Character encoding: UTF-8

Response Format

All responses are returned in JSON format. Success (Create Payment):

{
  "success": true,
  "status": "pending",
  "transaction_id": "tx_abc123",
  "gateway_transaction_id": "pi_xxxxx",
  ...
}

Success (Get Payment):

{
  "id": "tx_abc123",
  "status": "completed",
  "amount": 100,
  ...
}

Error:

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "Error message",
    "request_id": "req_abc123xyz789"
  }
}

For error code details, see Error Codes.

Transaction Status

Status	Description
`pending`	Payment created, awaiting customer action (redirect flow)
`requires_action`	Awaiting frontend action (card payment)
`authorized`	Authorization complete (awaiting manual capture)
`completed`	Payment completed
`failed`	Payment failed
`canceled`	Payment canceled
`partially_refunded`	Partially refunded
`refunded`	Fully refunded

Overview

Payments

Customers

Tokens

Webhook

OpenAPI Specification

Full Documentation

API Endpoints

Authentication

Request Format

Response Format

Transaction Status

OpenAPI Specification

Full Documentation

​API Endpoints

​Authentication

​Request Format

​Response Format

​Transaction Status

API Endpoints

Authentication

Request Format

Response Format

Transaction Status