EBANX

EBANX Tokenization API

Tokenize cards on EBANX so PAN never touches merchant servers, and refresh CVVs on stored tokens before high-risk reuse. Reusable tokens power one-click checkout, subscriptions, and stored-card flows.

GitHub OpenAPI

Documentation

📖
APIReference
https://docs.ebanx.com/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ebanx/refs/heads/main/openapi/ebanx-tokenization-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ebanx/refs/heads/main/json-schema/ebanx-card-token-schema.json

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/ebanx/refs/heads/main/apis.yml

OpenAPI Specification

ebanx-tokenization-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: EBANX FX Tokenization API
  version: '1.0'
  description: Retrieve current foreign exchange rates between local market currencies (BRL, MXN, COP, ARS, CLP, PEN, etc.) and pricing currencies (USD, EUR), and lock a rate via an FX token so a quoted price is honored at capture.
  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: Tokenization
paths:
  /ws/token:
    post:
      summary: Create Card Token
      operationId: createCardToken
      description: Create a reusable token for a credit or debit card.
      tags:
      - Tokenization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - integration_key
              - payment_type_code
              - creditcard
              - country
              properties:
                integration_key:
                  type: string
                payment_type_code:
                  type: string
                  description: 'Card brand: visa, mastercard, amex, hipercard, elo, etc.'
                country:
                  type: string
                creditcard:
                  type: object
                  required:
                  - card_number
                  - card_name
                  - card_due_date
                  - card_cvv
                  properties:
                    card_number:
                      type: string
                    card_name:
                      type: string
                    card_due_date:
                      type: string
                      description: MM/YYYY
                    card_cvv:
                      type: string
      responses:
        '200':
          description: Token created
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  token:
                    type: string
                  masked_card_number:
                    type: string
                  payment_type_code:
                    type: string
  /ws/token/setCVV:
    post:
      summary: Set Token CVV
      operationId: setTokenCVV
      description: Attach a fresh CVV to an existing card token, typically before reusing it for a high-risk transaction.
      tags:
      - Tokenization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - integration_key
              - token
              - cvv
              properties:
                integration_key:
                  type: string
                token:
                  type: string
                cvv:
                  type: string
      responses:
        '200':
          description: CVV bound to token
components:
  securitySchemes:
    integrationKey:
      type: apiKey
      in: header
      name: x-ebanx-integration-key