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

Openpay Charges API

Create and manage charges to cards, stores, and banks.

Openpay Charges API is one of 11 APIs that Openpay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Charges. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 4 base URLs: https://api.openpay.mx/v1, https://sandbox-api.openpay.mx/v1, https://api.openpay.co/v1, https://sandbox-api.openpay.co/v1.

7 operations 5 paths 8 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.openpay.mx/v1
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Openpay Charges API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. Use the merchant private API key as the username and leave the password empty.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Charges 7

Create and manage charges to cards, stores, and banks.

POST
/{merchant_id}/charges
Create a charge at the merchant level.
createMerchantCharge 1 param body → 200400402
GET
/{merchant_id}/charges
List charges at the merchant level.
listMerchantCharges 4 params → 200
GET
/{merchant_id}/charges/{transaction_id}
Get a charge by id.
getMerchantCharge 2 params → 200404
POST
/{merchant_id}/charges/{transaction_id}/refund
Refund a charge.
refundMerchantCharge 2 params body → 200
POST
/{merchant_id}/charges/{transaction_id}/capture
Capture a previously authorized charge.
captureMerchantCharge 2 params body → 200
POST
/{merchant_id}/customers/{customer_id}/charges
Create a charge at the customer level.
createCustomerCharge 2 params body → 200
GET
/{merchant_id}/customers/{customer_id}/charges
List a customer's charges.
listCustomerCharges 4 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Charge (15 properties), Card (10 properties), CreateCharge (9 properties), PaymentMethod (6 properties). Each schema is shown below with its type and property counts.

CaptureRequest
object
1 property
ChargeCustomer
object
4 properties
Error
object
6 properties
PaymentMethod
object
Method-specific payment details, present for store and bank charges (e.g. reference, barcodeurl, clabe, agreement, name).
6 properties
RefundRequest
object
2 properties
CreateCharge
object
9 properties 2 required
Card
object
10 properties
Charge
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openpay-charges-api-openapi.yml Raw ↑

Other APIs Openpay publishes across the network.

Openpay BankAccounts API
Openpay Cards API
Openpay Customers API
Openpay Fees API
Openpay Payouts API
Openpay Plans API
Openpay Subscriptions API
Openpay Tokens API
Openpay Transfers API
Openpay Webhooks API
Where this information came from

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