How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Payflex Refunds API

Initiate full or partial refunds on completed orders

Payflex Refunds API is one of 4 APIs that Payflex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Refunds. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.payflex.co.za, https://api.uat.payflex.co.za.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.payflex.co.za
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Payflex Refunds API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth2 Bearer token obtained from the /auth/merchant endpoint using the clientcredentials grant. Tokens expire and should be refreshed automatically before exp…

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.

Refunds 1

Initiate full or partial refunds on completed orders

POST
/order/{orderId}/refund
Initiate a refund on an order
createRefund 1 param body → 200201400401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RefundRequest (4 properties), RefundResponse (4 properties), ErrorResponse (2 properties), RefundErrorResponse (2 properties). Each schema is shown below with its type and property counts.

RefundErrorResponse
object
2 properties
RefundResponse
object
4 properties
RefundRequest
object
4 properties 2 required
ErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payflex-refunds-api-openapi.yml Raw ↑

Other APIs Payflex publishes across the network.

Payflex Authentication API
Payflex Configuration API
Payflex Orders API
Where this information came from

This is an independent, third-party profile of Payflex Refunds 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.