PayFast Onsite Checkout API
Generate payment identifiers for embedded (onsite) checkout flows
PayFast Onsite Checkout API is one of 13 APIs that PayFast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Onsite Checkout. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version v1.
Requests are made against 2 base URLs: https://api.payfast.co.za/v1, https://sandbox.payfast.co.za/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
PayFast Onsite Checkout API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as merchant-id (merchantAuth).
By default, every request must be authenticated.
merchantAuth— PayFast API authentication uses an MD5 signature derived from the merchant ID, passphrase, timestamp, and request data. Required headers include merchant-id, v…
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Generate payment identifiers for embedded (onsite) checkout flows
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are OnsitePaymentRequest (16 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from PayFast 12
Other APIs PayFast publishes across the network.
This is an independent, third-party profile of PayFast Onsite Checkout API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.