EBANX

https://docs.ebanx.com
Admin
EBANX provides comprehensive payment solutions for rising markets, enabling businesses to securely...
Tokens:750,707
Snippets:4,886
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Instalments Plan Request JSON Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-instalments-plan-request

A basic example of the JSON structure required for the instalments plan request.

```json
{
  "country_abbreviation": "BR",
  "currency_code": "BRL",
  "amount": 100
}
```

--------------------------------

### POST /ws/instalmentsPlan

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=introduction

Get available installment plans.

```APIDOC
## POST /ws/instalmentsPlan

### Description
Installments plan.

### Method
POST

### Endpoint
/ws/instalmentsPlan
```

--------------------------------

### Standard Instalments Plan JSON Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-__inline_response_instalmentsPlan_v0

An example of the JSON structure for a standard installments plan, showing an array containing an installment option object.

```json
[
  {
    "totalAmount": 103.5,
    "quantity": 1,
    "instalmentAmount": 103.5,
    "appliedFee": 0.01
  }
]
```

--------------------------------

### Provider Instalments Plan JSON Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-__inline_instalments-plan-success-response_instalmentsPlan_v1

A JSON representation of the Provider Instalments Plan object showing the structure for credit, debit, and credit_with_additional_limit modalities.

```json
{
  "credit": {
    "totalAmount": 2000,
    "quantity": 1,
    "instalmentAmount": 2257.81,
    "instalmentAmountPercentage": 100,
    "interest": 0.11,
    "interestAmount": 240.38,
    "iof": 17.43,
    "iofPercentage": 0.008,
    "totalAmountPercentage": 1.11,
    "amountContracted": 2017.43,
    "amountContractedPercentage": 1,
    "cet": 1.06,
    "installmentPlanAdditionalLimit": 2257.81,
    "additionalLimit": 5000,
    "additionalLimitMessage": "Additional limit available",
    "totalAmountWithInterest": 2257.81
  },
  "debit": {
    "totalAmount": 2000,
    "quantity": 1,
    "instalmentAmount": 2257.81,
    "instalmentAmountPercentage": 100,
    "interest": 0.11,
    "interestAmount": 240.38,
    "iof": 17.43,
    "iofPercentage": 0.008,
    "totalAmountPercentage": 1.11,
    "amountContracted": 2017.43,
    "amountContractedPercentage": 1,
    "cet": 1.06,
    "installmentPlanAdditionalLimit": 2257.81,
    "additionalLimit": 5000,
    "additionalLimitMessage": "Additional limit available",
    "totalAmountWithInterest": 2257.81
  },
  "credit_with_additional_limit": {
    "totalAmount": 2000,
    "quantity": 1,
    "instalmentAmount": 2257.81,
    "instalmentAmountPercentage": 100,
    "interest": 0.11,
    "interestAmount": 240.38,
    "iof": 17.43,
    "iofPercentage": 0.008,
    "totalAmountPercentage": 1.11,
    "amountContracted": 2017.43,
    "amountContractedPercentage": 1,
    "cet": 1.06,
    "installmentPlanAdditionalLimit": 2257.81,
    "additionalLimit": 5000,
    "additionalLimitMessage": "Additional limit available",
    "totalAmountWithInterest": 2257.81
  }
}
```

--------------------------------

### GET /ws/instalmentsPlan

Source: https://docs.ebanx.com/docs/pay-in/processing/payment-methods/country-specific/brazil/nupay-payment-conditions

Retrieves available installment plans by passing parameters directly in the URL query string.

```APIDOC
## GET /ws/instalmentsPlan

### Description
Retrieves available installment plans by passing parameters directly in the URL query string.

### Method
GET

### Endpoint
https://api.ebanxpay.com/ws/instalmentsPlan

### Parameters
#### Query Parameters
- **integration_key** (string) - Required - Your EBANX integration key.
- **country_abbreviation** (string) - Required - Two-letter country code (e.g., BR).
- **currency_code** (string) - Required - Three-letter currency code (ISO 4217). Set to BRL.
- **amount** (number) - Required - Total payment amount.
- **payment_type** (string) - Required - Payment type code (e.g., nupay, nupay-recurrent).
- **document** (string) - Conditional - Customer's CPF. Required when no enrollment_code is provided.
- **enrollment_code** (string) - Conditional - Customer's enrollment code. Required when no document is provided.
```

--------------------------------

### GET /ws/instalmentsPlan

Source: https://docs.ebanx.com/docs/pay-in/processing/payment-methods/country-specific/brazil/nupay-payment-conditions

Retrieves available funding sources and installment options from a customer's NuPay wallet to verify eligibility before initiating a payment.

```APIDOC
## GET /ws/instalmentsPlan

### Description
Retrieves available funding sources and installment options from a customer's NuPay wallet. This endpoint helps verify if a customer has sufficient balance or an eligible credit line for NuPay payments.

### Method
GET

### Endpoint
/ws/instalmentsPlan

### Requirements
- API authentication must be performed using JWS (JSON Web Signature).
```

--------------------------------

### Instalments Plan Error Response Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-instalments-plan-error-response

A standard JSON error response returned when a request to the /ws/instalmentsPlan endpoint fails.

```json
{
  "status": "ERROR",
  "status_code": "IPBP-001",
  "status_message": "Country abbreviation is required"
}
```

--------------------------------

### Create a payment request example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-pse-avanza

A minimal JSON object example for initiating a PSE Avanza payment request.

```json
{
  "amount_total": 99.85,
  "country": "co",
  "payment_type_code": "achpse",
  "currency_code": "COP"
}
```

--------------------------------

### Query NuPay installments via GET

Source: https://docs.ebanx.com/docs/pay-in/processing/payment-methods/country-specific/brazil/nupay-payment-conditions

Use the GET method to retrieve installment plans by passing parameters directly in the URL query string.

```bash
curl -X GET \
  --location 'https://sandbox.ebanxpay.com/ws/instalmentsPlan?integration_key={{integration_key}}&country_abbreviation=BR&currency_code=BRL&amount=100&document={{tax_id}}&payment_type=nupay-recurrent'
```

--------------------------------

### Create Enrollment Response Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-user-enrollment-response

A sample JSON response for a successful enrollment creation request.

```json
{
  "status": "SUCCESS",
  "redirect_url": "https://checkout.example.com/enrollment/abc123",
  "enrollment": "enrollment-11 | enrollment-12 | enrollment-13 | enrollment-14 | enrollment-15 | enrollment-16 | enrollment-17 | enrollment-18 | enrollment-19 | enrollment-20"
}
```

--------------------------------

### Get Bank List Request JSON Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-get-bank-list-request

A basic example of the request body containing the required country_code field.

```json
{
  "country_code": "co"
}
```

--------------------------------

### Install web-token/jwt-library via Composer

Source: https://docs.ebanx.com/docs/get-started/api-authentication/jws-integration

Run this command to install the required library for JWS operations.

```bash
composer require web-token/jwt-library
```

--------------------------------

### Mercado Pago Connect Enrollment Request Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-mercado-pago-connect

A basic JSON example showing the required fields for a Mercado Pago Connect enrollment request.

```json
{
  "merchant_enrollment_code": "my-enrollment-code-123",
  "country": "br"
}
```

--------------------------------

### Create a payment request example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-card-15

A basic JSON payload example for initiating a card payment in El Salvador.

```json
{
  "amount_total": 99.85,
  "country": "sv",
  "payment_type_code": "creditcard",
  "currency_code": "USD"
}
```

--------------------------------

### Get Bank List Error Response JSON

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-get-bank-list-error-response

An example of the JSON object returned when a request to get the bank list fails.

```json
{
  "status": "ERROR",
  "status_code": "BP-DR-77",
  "status_message": "Country is not enabled"
}
```

--------------------------------

### POST /ws/direct

Source: https://docs.ebanx.com/docs/pay-in/processing/payment-methods/country-specific/peru/yape-recurring

Create an enrollment and a payment in a single API request to simplify the integration.

```APIDOC
## POST /ws/direct

### Description
Create an enrollment and a payment in a single API request. This simplifies the integration by combining the enrollment creation and the first payment into one operation.

### Method
POST

### Endpoint
https://sandbox.ebanxpay.com/ws/direct

### Parameters
- **integration_key** (string) - Required - Your EBANX integration key.
- **payment.payment_type_code** (string) - Required - Set to `yape-recurrent`.
- **payment.merchant_payment_code** (string) - Required - Unique ID for the payment.
- **payment.email** (string) - Required - Customer email.
- **payment.country** (string) - Required - Set to `pe`.
- **payment.currency_code** (string) - Required - Set to `PEN`.
- **payment.phone_number** (string) - Required - Customer phone number connected to the Yape account.
- **payment.amount_total** (number) - Required - Total amount to charge.
- **payment.enrollment.merchant_enrollment_code** (string) - Required - Unique ID for the recurring enrollment.
- **payment.enrollment.subscription.frequency** (string) - Required - Billing cycle: `monthly`, `bimonthly`, `quarterly`, `halfyearly`, `yearly`, or `ondemand`.
- **payment.enrollment.subscription.source** (string) - Required - `mobile` (app-to-app) or `web` (web-to-app).

### Request Example
```json
{
  "integration_key": "{{integration_key}}",
  "payment": {
      "merchant_payment_code": "{{merchant_payment_code}}",
      "payment_type_code": "yape-recurrent",
      "amount_total": 99.85,
      "country": "pe",
      "currency_code": "PEN",
      "email": "john.doe@example.com",
      "phone_number": "5555555555",
      "enrollment": {
          "merchant_enrollment_code": "{{unique_enrollment_code}}",
          "subscription": {
              "frequency": "{{frequency}}",
              "source": "mobile"
          }
      }
  }
}
```
```

--------------------------------

### NuPay Installments Plan JSON Response

Source: https://docs.ebanx.com/docs/pay-in/processing/payment-methods/country-specific/brazil/nupay-payment-conditions

Example response structure for the NuPay installments plan, containing debit, credit, and credit_with_additional_limit options.

```json
{
    "instalmentsPlan": {
      "debit": [
        {
          "totalAmount": 100,
          "quantity": 1,
          "instalmentAmount": 100,
          "totalAmountWithInterest": 100
        }
      ],
      "credit": [
        {
          "totalAmount": 100,
          "quantity": 1,
          "instalmentAmount": 100,
          "totalAmountWithInterest": 100
        },
        {
          "totalAmount": 100,
          "quantity": 2,
          "instalmentAmount": 50,
          "totalAmountWithInterest": 100
        },
        {
          "totalAmount": 100,
          "quantity": 3,
          "instalmentAmount": 35.10,
          "interest": 0.049,
          "interestAmount": 4.90,
          "iof": 0.41,
          "cet": 77.54,
          "totalAmountWithInterest": 105.31
        }
      ],
      "credit_with_additional_limit": [
        {
          "totalAmount": 100,
          "quantity": 1,
          "instalmentAmount": 376.30,
          "interest": 0.11,
          "additionalLimit": 833,
          "totalAmountWithInterest": 376.30
        }
      ]
    }
}
```

--------------------------------

### Create a payment request example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-card-2

A basic JSON payload example for initiating a card payment request.

```json
{
  "amount_total": 99.85,
  "country": "br",
  "payment_type_code": "creditcard",
  "currency_code": "BRL"
}
```

--------------------------------

### Installments Plan API response example

Source: https://docs.ebanx.com/docs/pay-in/features/financial/installments

An abbreviated JSON response showing the breakdown of installment options, including total amounts, quantities, and applied fees.

```json
{
  "instalmentsPlan": [
    {
      "totalAmount": 1599.99,
      "quantity": 1,
      "instalmentAmount": 1599.99,
      "appliedFee": 0
    },
    {
      "totalAmount": 1648.79,
      "quantity": 2,
      "instalmentAmount": 824.40,
      "appliedFee": 0.03
    },
    {
      "totalAmount": 1665.59,
      "quantity": 3,
      "instalmentAmount": 555.20,
      "appliedFee": 0.04
    }
  ],
  "bin": {
    "bin": "411111",
    "brand": "VISA",
    "country": "BR"
  }
}
```

--------------------------------

### GET /ws/instalmentsPlan

Source: https://docs.ebanx.com/docs/pay-in/processing/payment-methods/country-specific/brazil/nupay-recurring

Retrieves available installment plans and amounts for NuPay Recurring.

```APIDOC
## GET /ws/instalmentsPlan

### Description
Retrieves the available installment plans and amounts before submitting the payment request. The document and payment_type fields are required.

### Method
GET

### Endpoint
/ws/instalmentsPlan
```

--------------------------------

### Create a Payment Request Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-card-8

A basic JSON payload example for initiating a card payment request in Guatemala.

```json
{
  "amount_total": 99.85,
  "country": "gt",
  "payment_type_code": "creditcard",
  "currency_code": "USD"
}
```

--------------------------------

### POST /ws/direct

Source: https://docs.ebanx.com/docs/pay-in/processing/payment-methods/country-specific/brazil/pix-automatico/enrollment/instant-payment

Initiates a Pix Automático enrollment and an instant payment by sending payment and subscription data to the /ws/direct endpoint.

```APIDOC
## POST /ws/direct

### Description
This endpoint is used to request a payment while adding enrollment data for Pix Automático. It generates a QR code for the user to scan in their banking app and sets up the recurring subscription.

### Method
POST

### Endpoint
https://sandbox.ebanxpay.com/ws/direct

### Parameters
#### Request Body
- **integration_key** (string) - Required - Your integration key
- **payment** (object) - Required - Payment and customer details
  - **merchant_payment_code** (string) - Required - Unique merchant payment code
  - **amount_total** (number) - Required - Total amount to be charged
  - **currency_code** (string) - Required - Must be BRL
  - **country** (string) - Required - Must be BR
  - **payment_type_code** (string) - Required - Must be pix-automatico
  - **expiration_time_in_seconds** (integer) - Optional - QR code expiration time in seconds
  - **email** (string) - Required - Customer e-mail
  - **name** (string) - Required - Customer name
  - **document** (string) - Required - Customer document
  - **enrollment** (object) - Required - Subscription and enrollment data
    - **country** (string) - Required - Must be BR
    - **email** (string) - Required - Customer e-mail
    - **name** (string) - Required - Customer name
    - **document** (string) - Required - Customer document
    - **merchant_enrollment_code** (string) - Required - Unique enrollment code
    - **subscription** (object) - Required - Subscription details
      - **subscription_name** (string) - Required - Service descriptor (max 35 chars)
      - **expiration_date** (string) - Optional - Enrollment validity date
      - **frequency** (string) - Required - Billing cycle (weekly, monthly, quarterly, halfyearly, yearly)
      - **retry** (string) - Required - Retry policy (not_allowed, allow_3R_7D)
      - **fixed_amount** (number) - Required - Fixed recurring amount
      - **start_date** (string) - Required - Subscription start date

### Request Example
{
  "integration_key": "your_ebanx_integration_key",
  "payment": {
    "merchant_payment_code": "{{unique_payment_code}}",
    "amount_total": 39.90,
    "currency_code": "BRL",
    "country": "BR",
    "payment_type_code": "pix-automatico",
    "expiration_time_in_seconds": 3600,
    "email": "john.doe@example.com",
    "name": "John Doe",
    "document": "{{tax_id}}",
    "enrollment": {
      "country": "BR",
      "email": "john.doe@example.com",
      "name": "John Doe",
      "document": "{{tax_id}}",
      "merchant_enrollment_code": "{{unique_enrollment_code}}",
      "subscription": {
        "subscription_name": "Descriptor of the subscription",
        "expiration_date": "2025-12-30",
        "frequency": "monthly",
        "retry": "allow_3R_7D",
        "fixed_amount": 19.90,
        "start_date": "2024-12-30"
      }
    }
  }
}
```

--------------------------------

### Provider Instalment Detail JSON Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-provider-instalment-detail

A JSON representation of a single installment option, including all relevant financial fields like interest, IOF, and total amounts.

```json
{
  "totalAmount": 2000,
  "quantity": 1,
  "instalmentAmount": 2257.81,
  "instalmentAmountPercentage": 100,
  "interest": 0.11,
  "interestAmount": 240.38,
  "iof": 17.43,
  "iofPercentage": 0.008,
  "totalAmountPercentage": 1.11,
  "amountContracted": 2017.43,
  "amountContractedPercentage": 1,
  "cet": 1.06,
  "installmentPlanAdditionalLimit": 2257.81,
  "additionalLimit": 5000,
  "additionalLimitMessage": "Additional limit available",
  "totalAmountWithInterest": 2257.81
}
```

--------------------------------

### Create a payment request example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-stablecoin-5

A basic JSON payload example for initiating a stablecoin payment request.

```json
{
  "amount_total": 99.85,
  "country": "pe",
  "payment_type_code": "usdt",
  "currency_code": "USDT"
}
```

--------------------------------

### Enrollment with Subscription JSON Object

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-enrollment-with-subscription

A complete example of the enrollment object, including customer identification, notification URLs, and detailed subscription recurrence settings.

```json
{
  "merchant_enrollment_code": "my-enrollment-code-123",
  "phone_number": 5555555555,
  "identification": 12345678901,
  "identification_type": "cpf",
  "notification_url": "https://merchant.example.com/notify",
  "back_urls": {
    "success": "https://merchant.example.com/success",
    "failure": "https://merchant.example.com/failure"
  },
  "country": "br",
  "email": "john.doe@example.com",
  "name": "John Doe",
  "document": "853.513.468-93",
  "subscription": {
    "expiration_date": "2026-01-15",
    "fixed_amount": 99.85,
    "frequency": "monthly",
    "frequency_qtd": 1,
    "max_amount": 500,
    "max_amount_floor": 99.85,
    "min_amount": 10,
    "recurrence_rule": "before",
    "recurrence_value": 1,
    "retry": "allow_3R_7D",
    "start_date": "2025-01-15",
    "subscription_name": "Monthly subscription"
  }
}
```

--------------------------------

### Additional Info JSON Response

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-additional-info

Example of the additional information object structure returned in an installments plan success response.

```json
{
  "credit_with_additional_limit": {
    "additionalLimitMessage": "Additional limit available"
  }
}
```

--------------------------------

### Create a Payment Request Example

Source: https://docs.ebanx.com/api-reference?api=pay-in&page=schema-stablecoin-6

A basic JSON payload example for initiating a stablecoin payment request in Uruguay.

```json
{
  "amount_total": 99.85,
  "country": "uy",
  "payment_type_code": "usdt",
  "currency_code": "USDT"
}
```
Tokens:
Raw