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

EBANX Payments API

The Payments API from EBANX — 12 operation(s) for payments.

EBANX Payments API is one of 6 APIs that EBANX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

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

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

Requests are made against 2 base URLs: https://api.ebanxpay.com, https://sandbox.ebanxpay.com.

12 operations 12 paths 5 schemas 12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.ebanxpay.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

EBANX Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-ebanx-integration-key (integrationKey). By default, every request must be authenticated.

Paths & Operations 12

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

Payments 12
POST
/ws/direct
Create Direct Payment
createDirectPayment body → 200
POST
/ws/capture
Capture Payment
capturePayment body → 200
POST
/ws/query
Query Payment
queryPayment body → 200
POST
/ws/cancel
Cancel Payment
cancelPayment body → 200
POST
/ws/refund
Refund Payment
refundPayment body → 200
POST
/ws/refundOrCancel
Refund Or Cancel Payment
refundOrCancelPayment body → 200
POST
/ws/instalmentsPlan
List Installments Plan
listInstallmentsPlan body → 200
POST
/ws/cardbin
Lookup Card BIN
lookupCardBin body → 200
POST
/ws/getBankList
List Available Banks
listAvailableBanks body → 200
POST
/ws/ewallet-availableEWallets
List Available E-Wallets
listAvailableEWallets body → 200
POST
/ws/updatecustomerbankinfo
Resend Bank Info
updateCustomerBankInfo body → 200
POST
/print
Print Voucher Or Slip
printVoucherOrSlip body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Payment (10 properties), RefundRequest (6 properties), PaymentResponse (4 properties), DirectPaymentRequest (3 properties). Each schema is shown below with its type and property counts.

RefundResponse
object
2 properties
RefundRequest
object
6 properties 2 required
Payment
object
10 properties
PaymentResponse
object
4 properties
DirectPaymentRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebanx-payments-api-openapi.yml Raw ↑

Other APIs EBANX publishes across the network.

EBANX Tokenization API
EBANX FX API
EBANX Payment Notifications
EBANX PaymentPage API
EBANX Payouts API
Where this information came from

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