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

OPay Cashier API

The OPay Cashier API is the primary merchant payment API behind OPay Checkout. It exposes a hosted Express Checkout endpoint (cashier/create returning a cashierUrl), server-to-server payment creation for 3DS bank cards, bank transfer, bank USSD, bank account, POS, OPay wallet QR, and reference code payments, plus status queries, cancel, refund, and refund-status operations. Authentication uses an Authorization Bearer token — the public key for cashier/create and an HMAC-SHA512 signature over the JSON body (signed with the merchant's private key) for all other endpoints — along with a MerchantId header.

OPay Cashier API is one of 3 APIs that OPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments, Cashier, Checkout, Cards, and Bank Transfer. The published artifact set on APIs.io includes API documentation, a getting-started guide, authentication docs, an API reference, and an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://liveapi.opaycheckout.com/api/v1/international, https://testapi.opaycheckout.com/api/v1/international.

2 operations 2 paths 10 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://liveapi.opaycheckout.com/api/v1/international
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

OPay Cashier API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (PublicKeyAuth). It accepts HTTP bearer tokens (SignatureAuth).

  • PublicKeyAuth — Bearer token = merchant public key (used for cashier/create).
  • SignatureAuth — Bearer token = HMAC-SHA512 of the JSON request body signed with the merchant private key.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Cashier 2

Hosted Express Checkout and order status.

POST
/cashier/create
Create Hosted Cashier Payment Order
createCashierPayment 1 param body → 200
POST
/cashier/status
Query Payment Status
queryPaymentStatus 1 param body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CashierCreateRequest (14 properties), UserInfo (4 properties), PaymentStatusRequest (3 properties), ApiEnvelope (2 properties). Each schema is shown below with its type and property counts.

ApiEnvelope
object
2 properties
Amount
object
2 properties 2 required
CashierCreateRequest
object
14 properties 5 required
PayMethod
string
PaymentStatusResponse
PaymentStatusRequest
object
3 properties
CashierCreateResponse
Product
object
2 properties
PaymentStatus
string
UserInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opay-cashier-api-openapi.yml Raw ↑

Other APIs OPay publishes across the network.

OPay Payments API
OPay Refunds API
Where this information came from

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