API Reference
API reference
Quick reference for the V1 (E-PRO compatible) endpoints
Endpoints
| Endpoint | Method | Summary |
|---|---|---|
/v1/payment/direct | POST | Authorize (and capture) a card payment |
/v1/payment/applepay | POST | Create an Apple Pay payment (hosted redirect) |
/v1/payment/googlepay | POST | Create a Google Pay payment (hosted redirect) |
/v1/refund | POST | Refund a previously captured payment (full) |
/v1/status | POST | Query the current status of a transaction |
Base URLs
Production https://api.settleflow.io
Sandbox https://api.sandbox.settleflow.ioEach environment has its own host and key prefix, and they must match: pk_test_ keys on the sandbox host, pk_live_ keys on the production host. See Sandbox & test cards.
Common request shape
POST /v1/<action>/direct HTTP/1.1
Host: api.sandbox.settleflow.io
Content-Type: application/json
epro-api-key: pk_test_...Common response shape
Success:
{
"Code": 0,
"Result": {
/* operation-specific */
}
}Error (HTTP 200 with a non-zero Code):
{ "Code": 206, "Error": "Invalid parameter CardNumber, check format or Luhn algorithm" }The full catalog of codes lives on the Error codes page.
Shared result fields
Every Result envelope — payment, refund, status — exposes the following:
| Field | Type | Description |
|---|---|---|
OperationType | enum | payment, refund, credit |
Status | enum | authorized, captured, failed, cancelled, pending, rejected_pw |
Tid | string | Your transaction reference |
Reference | string | Our identifier |
Amount | number | Amount in major currency units |
UserId | string | Your Uid supplied on the original payment |
Message | string | Human-readable outcome |
Date | string | YYYY-MM-DD HH:mm:ss (UTC) |