Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EBANX Payouts API

The Payouts API from EBANX — 12 operation(s) for payouts.

EBANX Payouts 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 Payouts. 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 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

12 operations 12 paths 4 schemas 12 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

EBANX Payouts 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.

Payouts 12
POST
/ws/payout/create
Create Payout
createPayout body → 200
POST
/ws/payout/commit
Commit Payout
commitPayout body → 200
POST
/ws/payout/cancel
Cancel Payout
cancelPayout body → 200
POST
/ws/payout/retrieve
Retrieve Payout
retrievePayout body → 200
POST
/ws/payout/search
Search Payouts
searchPayouts body → 200
POST
/ws/payout/simulate
Simulate Payout
simulatePayout body → 200
POST
/ws/payout/attach
Attach Invoice To Payout
attachPayoutInvoice body → 200
POST
/ws/payout/balance
Get Payout Balance
getPayoutBalance body → 200
POST
/ws/payout/banks
List Payout Banks
listPayoutBanks body → 200
POST
/ws/payout/bankDetails
Get Payout Bank Details
getPayoutBankDetails body → 200
POST
/ws/payout/verify_account
Verify Payee Bank Account
verifyPayeeBankAccount body → 200
POST
/ws/payee/create
Create Payee
createPayee body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PayoutRequest (9 properties), Payee (6 properties), PayoutResponse (2 properties), PayeeRequest (2 properties). Each schema is shown below with its type and property counts.

PayeeRequest
object
2 properties 2 required
PayoutResponse
object
2 properties
Payee
object
6 properties
PayoutRequest
object
9 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebanx-payouts-api-openapi.yml Raw ↑

Other APIs EBANX publishes across the network.

EBANX Tokenization API
EBANX FX API
EBANX Payment Notifications
EBANX PaymentPage API
EBANX Payments API