Payflex · Schema
Order Status Response
Response returned by GET /order/{orderId} containing current order state and details
BNPLBuy Now Pay LaterPaymentsInstallmentsSouth AfricaFintechE-Commerce
Properties
| Name | Type | Description |
|---|---|---|
| orderId | string | Payflex-issued unique order identifier |
| orderStatus | string | Current status of the Payflex order |
| merchantReference | string | Merchant's own order reference |
| amount | number | Order total amount |
| consumer | object | Consumer contact details |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/payflex/main/json-schema/order-status-response.json",
"title": "Order Status Response",
"description": "Response returned by GET /order/{orderId} containing current order state and details",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Payflex-issued unique order identifier",
"example": "ord_abc123xyz"
},
"orderStatus": {
"type": "string",
"description": "Current status of the Payflex order",
"enum": ["Created", "Initiated", "Approved", "Declined", "Abandoned", "Cancelled"],
"example": "Approved"
},
"merchantReference": {
"type": "string",
"description": "Merchant's own order reference",
"example": "12345"
},
"amount": {
"type": "number",
"description": "Order total amount",
"example": 299.99
},
"consumer": {
"type": "object",
"description": "Consumer contact details",
"properties": {
"phoneNumber": { "type": "string", "example": "+27821234567" },
"givenNames": { "type": "string", "example": "Jane" },
"surname": { "type": "string", "example": "Smith" },
"email": { "type": "string", "format": "email", "example": "jane.smith@example.com" }
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/order-status-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.