EBANX

EBANX PaymentPage API

The PaymentPage API from EBANX — 1 operation(s) for paymentpage.

GitHub OpenAPI
Business capability
Consumer Payment Options AE-140.30

Operations 1

POST /ws/request Create Payment Page Request #

Documentation

📖
APIReference
https://docs.ebanx.com/api/
📖
Documentation
https://docs.ebanx.com/docs/pay-in/solution/integration-methods/direct-api
📖
Documentation
https://docs.ebanx.com/docs/pay-in/solution/pay-in-guide
📖
Documentation
https://docs.ebanx.com/docs/pay-in/solution/integration-methods/payment-page
📖
Documentation
https://docs.ebanx.com/docs/payout/payouts-overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ebanx/openapi/ebanx-paymentpage-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ebanx/json-schema/ebanx-payment-schema.json
📊
JSONSchema
https://artifacts.apis.io/ebanx/json-schema/ebanx-refund-schema.json
📊
JSONStructure
https://artifacts.apis.io/ebanx/json-structure/ebanx-payment-structure.json
📊
JSONSchema
https://artifacts.apis.io/ebanx/json-schema/ebanx-payout-schema.json
📊
JSONStructure
https://artifacts.apis.io/ebanx/json-structure/ebanx-payout-structure.json

Other Resources

🔗
Examples
https://artifacts.apis.io/ebanx/examples/ebanx-create-direct-payment-pix-example.json
🔗
Examples
https://artifacts.apis.io/ebanx/examples/ebanx-create-direct-payment-card-example.json
🔗
Examples
https://artifacts.apis.io/ebanx/examples/ebanx-create-payout-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ebanx:ebanx-paymentpage-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ebanx-paymentpage-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: EBANX Payment Page API
  version: '1.0'
  description: Hosted EBANX checkout. The merchant submits payment parameters and EBANX renders the full payment UI, validates the customer input, processes the payment, and returns the customer to the merchant via a redirect URL.
  contact:
    name: EBANX Sales Engineering
    email: sales.engineering@ebanx.com
    url: https://docs.ebanx.com
servers:
- url: https://api.ebanxpay.com
  description: Production environment
- url: https://sandbox.ebanxpay.com
  description: Sandbox environment for testing
security:
- integrationKey: []
tags:
- name: PaymentPage
paths:
  /ws/request:
    post:
      summary: Create Payment Page Request
      operationId: createPaymentPageRequest
      description: Create a hosted payment page session and return a redirect URL the merchant can send the customer to in order to complete the payment.
      tags:
      - PaymentPage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - integration_key
              - payment
              properties:
                integration_key:
                  type: string
                payment:
                  type: object
                  properties:
                    name:
                      type: string
                    email:
                      type: string
                      format: email
                    document:
                      type: string
                    country:
                      type: string
                    merchant_payment_code:
                      type: string
                    currency_code:
                      type: string
                    amount_total:
                      type: number
                      format: float
                    payment_type_code:
                      type: string
                      description: Optional. Pre-select a payment method or _all for the full menu.
                    redirect_url:
                      type: string
                      format: uri
      responses:
        '200':
          description: Payment page session created
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  redirect_url:
                    type: string
                    format: uri
                    description: URL to send the customer to in order to complete payment.
                  payment:
                    type: object
                    properties:
                      hash:
                        type: string
                      merchant_payment_code:
                        type: string
components:
  securitySchemes:
    integrationKey:
      type: apiKey
      in: header
      name: x-ebanx-integration-key