### Shopify EBANX Integration Steps

Source: https://docs.ebanx.com/docs/payments/integration-methods/plugins/shopify/shopify-install

This section outlines the core steps for integrating EBANX into a Shopify store, including obtaining credentials, installing the app, and configuring payment settings.

```text
1. Get your Integration Key from EBANX dashboard (Settings > Integrations).
2. Install EBANX Payment App on Shopify.
3. Enter Integration Key and Log In.
4. Activate EBANX Payment App in Shopify settings.
5. Configure Form Options in Shopify Checkout settings.
6. For Brazil: Manage Checkout Language, set Optional company label to CPF.
```

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

### Installments Plan Response Sample

Source: https://docs.ebanx.com/api

Example JSON response for the installments plan endpoint. It details various installment options, including total amount, quantity, installment amount, and applied fees for each. It also includes BIN information such as brand and country.

```JSON
{
  "instalmentsPlan": [
    {
      "totalAmount": "1606.07",
      "quantity": 1,
      "instalmentAmount": 1606.07,
      "appliedFee": 0
    },
    {
      "totalAmount": "1655.74",
      "quantity": 2,
      "instalmentAmount": 827.87,
      "appliedFee": 0.03
    },
    {
      "totalAmount": "1672.99",
      "quantity": 3,
      "instalmentAmount": 557.66,
      "appliedFee": 0.04
    },
    {
      "totalAmount": "1690.6",
      "quantity": 4,
      "instalmentAmount": 422.65,
      "appliedFee": 0.05
    },
    {
      "totalAmount": "1708.59",
      "quantity": 5,
      "instalmentAmount": 341.72,
      "appliedFee": 0.06
    },
    {
      "totalAmount": "1726.96",
      "quantity": 6,
      "instalmentAmount": 287.83,
      "appliedFee": 0.07
    },
    {
      "totalAmount": "1745.73",
      "quantity": 7,
      "instalmentAmount": 249.39,
      "appliedFee": 0.08
    },
    {
      "totalAmount": "1764.91",
      "quantity": 8,
      "instalmentAmount": 220.61,
      "appliedFee": 0.09
    },
    {
      "totalAmount": "1784.53",
      "quantity": 9,
      "instalmentAmount": 198.28,
      "appliedFee": 0.1
    },
    {
      "totalAmount": "1804.57",
      "quantity": 10,
      "instalmentAmount": 180.46,
      "appliedFee": 0.11
    },
    {
      "totalAmount": "1825.08",
      "quantity": 11,
      "instalmentAmount": 165.92,
      "appliedFee": 0.12
    },
    {
      "totalAmount": "1846.06",
      "quantity": 12,
      "instalmentAmount": 153.84,
      "appliedFee": 0.13
    }
  ],
  "bin": {
    "bin": "411111",
    "brand": "VISA",
    "country": "BR"
  }
}
```

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

### EBANX Sandbox Integration Example

Source: https://docs.ebanx.com/ebanx-integration-prompt

This snippet demonstrates how to integrate with the EBANX API in a sandbox environment. It requires setting up sandbox base URLs and using specific integration keys. The example includes placeholders for API calls, response handling, and error management, along with comments guiding the implementation.

```javascript
// [programming_language]
// [Comments explaining the code]
// Include necessary imports
// Set EBANX sandbox base URL/endpoint
// Use sandbox integration keys
// Implement the specific EBANX API call
// Handle response and potential errors
```

```python
# [programming_language]
# [Comments explaining the code]
# Include necessary imports
# Set EBANX sandbox base URL/endpoint
# Use sandbox integration keys
# Implement the specific EBANX API call
# Handle response and potential errors
```

```php
// [programming_language]
// [Comments explaining the code]
// Include necessary imports
// Set EBANX sandbox base URL/endpoint
// Use sandbox integration keys
// Implement the specific EBANX API call
// Handle response and potential errors
```

```java
// [programming_language]
// [Comments explaining the code]
// Include necessary imports
// Set EBANX sandbox base URL/endpoint
// Use sandbox integration keys
// Implement the specific EBANX API call
// Handle response and potential errors
```

```ruby
# [programming_language]
# [Comments explaining the code]
# Include necessary imports
# Set EBANX sandbox base URL/endpoint
# Use sandbox integration keys
# Implement the specific EBANX API call
# Handle response and potential errors
```

```csharp
// [programming_language]
// [Comments explaining the code]
// Include necessary imports
// Set EBANX sandbox base URL/endpoint
// Use sandbox integration keys
// Implement the specific EBANX API call
// Handle response and potential errors
```

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

### Curl Request for Installments Plan

Source: https://docs.ebanx.com/api

Example cURL command to request an installments plan. It specifies the endpoint, HTTP method, and includes query parameters for country, integration key, currency, amount, and BIN.

```Bash
curl --location --request GET 'https://sandbox.ebanx.com/ws/instalmentsPlan/?country_abbreviation=br&integration_key={{your_ebanx_integration_key}}&currency_code=BRL&amount=1599.99&bin=411111'
```

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

### Explore EBANX Payment Links Integration Guide

Source: https://docs.ebanx.com/docs/payments/integration-methods/payments-by-link

This snippet provides a link to the EBANX integration guide for payment links. It's a starting point for merchants looking to implement this feature.

```Documentation
Click to explore our integration guide for EBANX payment links.
Click to explore _chevron_right_
```

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

### Initialize EBANX.js

Source: https://docs.ebanx.com/docs/integration/libraries/ebanx-js

Initialize the EBANX.js library with your public integration key, the relevant country code, and the operating mode (test or production). This setup is crucial for processing payments.

```JavaScript
EBANX.init({
  publicIntegrationKey: '{your_public_integration_key}',
  country: '{selected_country_code}',
  mode: 'test',
});
```

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

### Install EBANX.js via Script Tag

Source: https://docs.ebanx.com/docs/payments/guides/features/drop-in

This snippet shows how to include the EBANX.js library in your HTML document using a script tag, making its functionalities available for use.

```html
<script src="https://ebanx-js.ebanx.com/latest/dist/ebanx.min.js"></script>
```

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

### Install EBANX.js via Script Tag

Source: https://docs.ebanx.com/docs/integration/libraries/ebanx-js

Include the EBANX.js library in your HTML using a script tag to enable its payment functionalities on your website.

```HTML
<script src="https://ebanx-js.ebanx.com/latest/dist/ebanx.min.js"></script>
```

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

### EBANX Tokenization Response Example

Source: https://docs.ebanx.com/docs/payments/guides/features/tokenization/ebanx-network-tokens

This is an example of a successful response from the EBANX tokenization service, containing the generated token, masked card number, and other relevant transaction details.

```json
{
  "status": "SUCCESS",
  "payment_type_code": "mastercard",
  "token": "b81cc06bcf0d013c3688eb1b229dc155cd23b5d18781bee0fb246537cb42f151117ae7f06617cae384d4829c82151983177c87584686fad5e497dde1d0871862",
  "masked_card_number": "520000xxxxxx1096",
  "network_token_status": "ACTIVE",
  "card_unique_id": "2768279443911D"
}


```

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

### EBANX Tokenization for PCI Compliance

Source: https://docs.ebanx.com/docs/payments/get-started

If your system is not PCI compliant, EBANX offers a JavaScript library (EBANX JS) to tokenize customer credit card information. This allows for secure payment processing without direct handling of sensitive card data, ensuring compliance with security standards.

```JavaScript
/*
 * EBANX JS for tokenizing credit card data.
 * This library helps achieve PCI compliance by tokenizing sensitive card details.
 * Ensure you have included the EBANX JS library in your project.
 */

// Example usage (assuming EBANX JS is loaded and initialized):
// EBANX.token.createToken({
//   card_number: '...', 
//   card_expiration_date: '...', 
//   card_cvv: '...'
// }, function(err, response) {
//   if (err) {
//     console.error('Tokenization failed:', err);
//   } else {
//     console.log('Token created:', response.token);
//     // Use the token for payment processing
//   }
// });
```

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

### Initialize EBANX SDK

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/cards-3ds-2

Initialize the EBANX.js SDK with your public integration key, country code, and operating mode (test or production). This setup is crucial before making any payment-related calls.

```JavaScript
EBANX.init({
  publicIntegrationKey: '{your_public_integration_key}',
  country: '{country_code_here}',
  mode: 'test',
});
```

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

### Sample EBANX Payment Success Response

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/credit-cards

Provides an example of a successful payment response from EBANX, detailing transaction status, amounts, currency, and other relevant payment information.

```JSON
{
  "payment": {
    "hash": "59ad5f00945fa382ab051651440826da7701533249b3a475",
    "country": "br",
    "merchant_payment_code": "ecc9be4512a",
    "order_number": null,
    "status": "CO",
    "status_date": "2017-09-04 14:11:12",
    "open_date": "2017-09-04 14:11:11",
    "confirm_date": "2017-09-04 14:11:12",
    "transfer_date": null,
    "amount_br": "100.38",
    "amount_ext": "100.00",
    "amount_iof": "0.38",
    "currency_rate": "1.0000",
    "currency_ext": "BRL",
    "due_date": "2017-09-07",
    "installments": "3",
    "payment_type_code": "visa",
    "details": {
      "billing_descriptor": ""
    },
    "transaction_status": {
      "acquirer": "EBANX",
      "code": "OK",
      "description": "Sandbox - Test credit card, transaction captured"
    },
    "pre_approved": true,
    "capture_available": false
  },
  "status": "SUCCESS"
}
```

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

### Mount EBANX Drop-in with Customization

Source: https://docs.ebanx.com/docs/payments/guides/features/drop-in

Demonstrates mounting the EBANX Drop-in UI to a specified HTML element. It includes options for amount, prefilled values, visual customization (look and feel), installment limits, and payment method selection.

```javascript
dropin.mount('#dropin', { 
  amount: '100',
  values: valuesOption, 
  lookAndFeel: {  
    name: 'vanilla',
    primaryColor: '#4C70FC',
  },
  instalments: 12,
  paymentMethods: ['creditcard', 'debitcard'],
});
```

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

### Access EBANX Dashboard

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/payment-link

This snippet provides the URL to access the EBANX Dashboard, which is the starting point for creating payment links.

```text
https://dashboard.ebanx.com
```

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

### EBANX Enrollment Query Successful Response

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/brazil/pix-automatico/variable-enrollments

Example JSON response from querying an EBANX enrollment status. Shows a successful query with the enrollment status updated to 'accepted' and customer email.

```json
{
   "status": "SUCCESS",
   "enrollment": {
    "status": "accepted",
    "email": "{{customer_email}}"
        },
        "subscription": {
            "subscription_name": "Descriptor of the subscription.",
            "expiration_date": "2025-12-30",
            "frequency": "monthly",
            "fixed_amount": null,
            "max_amount_floor": 100.00,
            "retry": "allow_3R_7D"
        }
}
```

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

### Initiate EBANX Payment Request (Brazil)

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/debit-cards

Example cURL request to initiate a direct payment via EBANX for Brazil, including customer and card details.

```curl
curl -X POST \
    --location 'https://sandbox.ebanx.com/ws/direct' \
    --header 'Content-Type: application/json' \
    --data '{ \
  "integration_key": "your_ebanx_integration_key", \
  "operation": "request", \
  "payment": { \
    "name": "José Silva", \
    "email": "jose@example.com", \
    "document": "853.513.468-93", \
    "address": "Rua E", \
    "street_number": "1040", \
    "city": "Maracanaú", \
    "state": "CE", \
    "zipcode": "61919-230", \
    "country": "br", \
    "phone_number": "8522847035", \
    "payment_type_code": "debitcard", \
    "merchant_payment_code": "ecc9be4512a", \
    "currency_code": "BRL", \
    "installments": 1, \
    "amount_total": 100, \
    "card": { \
      "card_number": "4111111111111111", \
      "card_name": "José Silva", \
      "card_due_date": "12/2019", \
      "card_cvv": "123", \
      "threeds_eci": "05", \
      "threeds_cryptogram": "AAIBAkl0NwmHglFBAXQ3AAAAAAA", \
      "threeds_xid": "AAIBAkl0NwmHglFBAXQ3AAAAAAA", \
      "threeds_version": "2", \
      "threeds_trxid": "AAIBAkl0NwmHglFBAXQ3AAAAAAA" \
    } \
  } \
}'
```

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

### EBANX Pix Automático Enrollment Response

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/brazil/pix-automatico/variable-enrollments

Example JSON response for a successful EBANX Pix Automático enrollment. Includes status, redirect URL for the voucher, and enrollment details with subscription information and the QR code value.

```json
{
    "status": "SUCCESS",
    "redirect_url": "https://sandbox.ebanx.com/ewallet/recurrency-agreement?return_url=https%3A%2F%2Fsandbox.ebanx.com%2Fws%2Fcustomerenrollment-finish%2Ffake%3Fenrollment%3DMTYwOTA6bXktZW5yb2xsbWVudC0zMzA%253D&enrollment_uuid=PpKBQFh3wwa4agh9e",
    "enrollment": {
        "merchant_enrollment_code": "{{unique_enrollment_code}}",
        "country": "BR",
        "name": "{{customer_name}}",
        "email": "{{customer_email}}",
        "subscription": {
            "frequency": "monthly",
            "expiration_date": "2025-12-30",
            "subscription_name": "Descriptor of the subscription.",
            "start_date": {
                "date": "2024-12-15",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "retry": "allow_3R_7D",
            "max_amount_floor": "100.00",
            "qr_code_value": "00020101021226780014br.gov.bcb.pix2556fake-pix.com.br/qr/v2/ACA4311F88661BC0D48200487EF1BCD95204000053039865802BR5910FAKEPIX Ltda6008CURITIBA62070503***36923"
        }
    }
}
```

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

### Get FX Token - Request Sample

Source: https://docs.ebanx.com/api

This sample illustrates how to request an FX token for fixed exchange rate operations. It requires your integration key, the country code, the currency to convert from, and the currency to convert to.

```json
{
  "integration_key": "your_test_integration_key",
  "country": "CO",
  "currency_from": "USD",
  "currency_to": "COP"
}
```

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

### EBANX Enrollment Query API Request

Source: https://docs.ebanx.com/docs/payments/guides/features/enrollment-notification

This example demonstrates how to construct a JSON request to the EBANX API to query the status of a customer enrollment. It includes necessary parameters like integration key, operation type, payment method, and enrollment details.

```JSON
{
    "integration_key": "testabc123",
    "operation": "enrollment",
    "payment_type_code": "mpconnect",
    "enrollment": {
        "merchant_enrollment_code": "test-enrollment-123",
        "country": "br"
    }
}
```

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

### Get Installments Plan (Brazil)

Source: https://docs.ebanx.com/api

Retrieves the installments plan for a given amount and currency in Brazil. Requires an integration key, country abbreviation, currency code, and amount. The response includes a list of installment options with total amount, quantity, installment amount, and applied fees.

```HTTP
GET https://sandbox.ebanx.com/ws/instalmentsPlan/?country_abbreviation=br&integration_key={{your_ebanx_integration_key}}&currency_code=BRL&amount=1599.99&bin=411111
```

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

### Sample JSON Response (Say Hello)

Source: https://docs.ebanx.com/api

A simple JSON response sample indicating a 'hello world' message.

```JSON
{
  "say": "hello world"
}
```

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

### Create EBANX Drop-in Instance

Source: https://docs.ebanx.com/docs/payments/guides/features/drop-in

This snippet shows how to create an instance of the EBANX Drop-in service. No specific parameters are required for basic instantiation.

```javascript
const dropin = EBANX.dropin.create();
```

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

### Get EBANX Available Banks (JSON Response)

Source: https://docs.ebanx.com/api

Example JSON response detailing available banks across various South American countries. Banks are listed with their codes or names.

```json
{
  "type": "success",
  "argentina": {
    "389": "BANCO COLUMBIA S.A.",
    "005": "AMBN AMRO BANK N. V."
  },
  "bolivia": [
    "10001 Banco de Desarrollo Productivo S.A.M.",
    "74003 Banco PYME de la Comunidad S.A."
  ],
  "brazil": [
    "104  Caixa Econômica",
    "001  Banco do Brasil"
  ],
  "chile": [
    "001  BANCO DE CHILE",
    "504  SCOTIABANK AZUL (BBVA)"
  ],
  "colombia": [
    "1040  Banco Agrario",
    "1014  Helm Bank S.A"
  ],
  "ecuador": [
    "BANCO AMAZONAS S.A.",
    "BANCO DINERS CLUB DEL ECUADOR"
  ],
  "mexico": {
    "168": "HIFED - HIPOTECARIA FEDERAL",
    "001": "BANCO - BANXICO"
  },
  "peru": [
    "BCP - BANCO DE CREDITO DO PERU",
    "INTERBANK"
  ]
}
```

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

### EBANX Tokenization for PCI Compliance

Source: https://docs.ebanx.com/index

If your system is not PCI compliant, EBANX offers a JavaScript solution to tokenize customer credit card information. This allows for secure payment processing without direct handling of sensitive card data.

```JavaScript
/*
 * EBANX JS for tokenizing credit cards.
 * This script helps merchants achieve PCI compliance by tokenizing card details.
 * Ensure you include the EBANX.js library in your project.
 */
// Example usage (assuming EBANX.js is loaded and initialized):
// EBANX.token.createCardToken({
//   card_number: '...', 
//   card_expiration_date: '...', 
//   card_cvv: '...', 
//   card_name: '...'
// }, function(token) {
//   console.log('Card token created:', token);
//   // Use this token for payment processing
// });
```

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

### Example Digital Wallet Response

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/chile/digital-wallets-chile

Sample JSON response from the /ws/ewallet-availableewallets endpoint, listing digital wallets with their codes, names, icons, and promotional text.

```json
[
  {
    "code": "nequi",
    "name": "Nequi",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png",
    "promotional_text": "This is promotional text"
  },
  {
    "code": "paypal",
    "name": "PayPal",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/paypal/icon.png",
    "promotional_text": "Pay easily with PayPal."
  }
]
```

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

### Example Digital Wallet Response

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/brazil/digital-wallets-brazil

Sample JSON response from the /ws/ewallet-availableewallets endpoint, listing digital wallets with their codes, names, icons, and promotional text.

```json
[
  {
    "code": "nequi",
    "name": "Nequi",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png",
    "promotional_text": "This is promotional text"
  },
  {
    "code": "paypal",
    "name": "PayPal",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/paypal/icon.png",
    "promotional_text": "Pay easily with PayPal."
  }
]
```

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

### Initialize EBANX.js with Integration Key

Source: https://docs.ebanx.com/docs/payments/guides/features/drop-in

This JavaScript code demonstrates how to initialize the EBANX.js library with your public integration key, country code, and operating mode. This is a crucial step before using any EBANX payment functionalities.

```javascript
EBANX.init({
  publicIntegrationKey: '{your_public_integration_key}',
  country: '{country_code_here}',
  mode: 'test',
});
```

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

### Example Response for Brazil States

Source: https://docs.ebanx.com/docs/payments/guides/features/get-states

This is an example of the JSON response received when fetching the states list for Brazil. The response includes the total quantity of states and an array of state objects, each containing a state code and name.

```JSON
// statesList
{
    "quantity": 27,
    "stateList": [
        {
            "stateCode": "AC",
            "stateName": "Acre"
        },
        {
            "stateCode": "AL",
            "stateName": "Alagoas"
        },
        {
            "stateCode": "AP",
            "stateName": "Amapá"
        },
        {
            "stateCode": "AM",
            "stateName": "Amazonas"
        },
        {
            "stateCode": "BA",
            "stateName": "Bahia"
        },
        {
            "stateCode": "CE",
            "stateName": "Ceará"
        },
        {
            "stateCode": "DF",
            "stateName": "Distrito Federal"
        },
        {
            "stateCode": "ES",
            "stateName": "Espírito Santo"
        },
        {
            "stateCode": "GO",
            "stateName": "Goiás"
        },
        {
            "stateCode": "MA",
            "stateName": "Maranhão"
        },
        {
            "stateCode": "MT",
            "stateName": "Mato Grosso"
        },
        {
            "stateCode": "MS",
            "stateName": "Mato Grosso do Sul"
        },
        {
            "stateCode": "MG",
            "stateName": "Minas Gerais"
        },
        {
            "stateCode": "PA",
            "stateName": "Pará"
        },
        {
            "stateCode": "PB",
            "stateName": "Paraíba"
        },
        {
            "stateCode": "PR",
            "stateName": "Paraná"
        },
        {
            "stateCode": "PE",
            "stateName": "Pernambuco"
        },
        {
            "stateCode": "PI",
            "stateName": "Piauí"
        },
        {
            "stateCode": "RJ",
            "stateName": "Rio de Janeiro"
        },
        {
            "stateCode": "RN",
            "stateName": "Rio Grande do Norte"
        },
        {
            "stateCode": "RS",
            "stateName": "Rio Grande do Sul"
        },
        {
            "stateCode": "RO",
            "stateName": "Rondônia"
        },
        {
            "stateCode": "RR",
            "stateName": "Roraima"
        },
        {
            "stateCode": "SC",
            "stateName": "Santa Catarina"
        },
        {
            "stateCode": "SP",
            "stateName": "São Paulo"
        },
        {
            "stateCode": "SE",
            "stateName": "Sergipe"
        },
        {
            "stateCode": "TO",
            "stateName": "Tocantins"
        }
    ]
}

```

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

### Example Digital Wallet Response

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/uruguay/digital-wallets-uruguay

Sample JSON response from the /ws/ewallet-availableewallets endpoint, listing digital wallets with their codes, names, icons, and promotional text.

```json
[
  {
    "code": "nequi",
    "name": "Nequi",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png",
    "promotional_text": "This is promotional text"
  },
  {
    "code": "paypal",
    "name": "PayPal",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/paypal/icon.png",
    "promotional_text": "Pay easily with PayPal."
  }
]
```

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

### Set CPF/CNPJ Field Label in Shopify Checkout Language

Source: https://docs.ebanx.com/docs/get-started/integration-methods/plugins/ebanx-shopify-plugin

This guide explains how to modify the checkout language settings in Shopify to set the 'Optional company label' field to 'CPF' for Brazil-specific requirements. This ensures the correct identification number is requested during checkout for orders shipping to Brazil.

```text
Remain on the same page (Settings > Checkout), scroll to the bottom, and select Manage Checkout Language under Checkout Language configuration.
Change the Optional company label field to CPF and save this page.
```

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

### EBANX Direct API Payment Request Example

Source: https://docs.ebanx.com/docs/payments/integration-methods/google-pay

This cURL command shows a complete example of initiating a payment request to the EBANX Direct API. It includes all required parameters for a Google Pay transaction, such as integration key, operation type, payment details, and the Google Pay token.

```shell
curl -X POST \
  --location 'https://api.ebanx.com/ws/direct' \
  --header 'Content-Type: application/json' \
  --data '{ \
    "integration_key": "your_ebanx_integration_key", \
    "operation": "request", \
    "payment": { \
      "name": "José Silva", \
      "email": "jose@example.com", \
      "document": "853.513.468-93", \
      "address": "Rua E", \
      "street_number": "1040", \
      "city": "Maracanaú", \
      "state": "CE", \
      "zipcode": "61919-230", \
      "country": "br", \
      "phone_number": "8522847035", \
      "payment_type_code": "creditcard", \
      "merchant_payment_code": "<%= random_order_id %>", \
      "currency_code": "BRL", \
      "amount_total": 100, \
      "card": { \
        "card_name": "José Silva", \
        "google_pay": "{\"signature\":\"MEUCIFU/vJavw2HKB4bHbVxZp1JqaIdUa5R1ENbk59MG +  \
        fHFAiEA1UBu7ZS1YC1v + Go6ScIbel / XyBKVt29Qr1mSdObWIig\ u003d\ ",\"protoc  \
        olVersion\ ":\"ECv1\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"  \
        ZkxOdAiV2EJXbNRkU1izADoLPyQtidbSvAC4HxnAGJPkFcnFbwwMVKHeXYjmkGbIjAg  \
        3 uzIqsds1G5NrDMzwwztdwmPQ0BjE3lIhVASIg1iljIiNQzcTkhHqTMc01Rs9yn3w2T9W  \
        gws2UGJ42YEnkeiVPjQfM3NvIAmxwCA8CAWrYZFmQfQCUGHK6H0dZolvjGGI8YtNwaImo  \
        4 aC6YMCo4t9FfwT + pITZdS9BfIMmjx2iXzjZF1Iy + c53lwzVVFEljGF5mh6cHEzZdKCVj  \
        F5U11tKt6MybAkEU6yxEqOfdjp41FwjcJ3SknlzrDBrFXqL66cq + xtfCGTPfRvzs7SnFE  \
"}\"}" \
      } \
    } \
  }'
```

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

### EBANX Tokenized Card Payment

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/debit-cards

Example of how to structure the 'card' object when using tokenized card information for an EBANX payment.

```json
{
  "token": "card_token_here"
}
```

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

### Install EBANX.js

Source: https://docs.ebanx.com/docs/payments/guides/features/get-states

Include the EBANX.js library in your HTML by adding the provided script tag to your document's head or body.

```html
<script src="https://ebanx-js.ebanx.com/latest/dist/ebanx.min.js"></script>
```

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

### Shopify Checkout Language Configuration

Source: https://docs.ebanx.com/docs/payments/integration-methods/plugins/shopify/shopify-install

Instructions on how to manage checkout language settings in Shopify, specifically for setting the 'Optional company label' to 'CPF' for Brazil-specific requirements.

```text
Navigate to Settings > Checkout.
Scroll to Manage Checkout Language under Checkout Language configuration.
Change the Optional company label field to CPF.
Save the page.
```

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

### Install EBANX.js Library

Source: https://docs.ebanx.com/docs/payments/guides/features/tokenization/tokenization

Include the EBANX.js JavaScript library in your HTML file by adding a script tag to load the latest version from the CDN.

```html
<script type="text/javascript" src="https://ebanx-js.ebanx.com/latest/dist/ebanx.min.js"></script>
```

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

### Initialize EBANX.js

Source: https://docs.ebanx.com/docs/payments/guides/features/get-states

Initialize the EBANX.js library with your public integration key and the desired country code. This setup is necessary before making any EBANX API calls.

```javascript
EBANX.init({
  publicIntegrationKey: '{your_public_integration_key}',
  country: '{country_code_here}',
  mode: 'test',
});
```

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

### Example Digital Wallet Response

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/mexico/digital-wallets-mexico

This is a sample JSON response from the EBANX API listing available digital wallets for a given country, including their code, name, icon URL, and promotional text.

```json
[
  {
    "code": "nequi",
    "name": "Nequi",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png",
    "promotional_text": "This is promotional text"
  },
  {
    "code": "paypal",
    "name": "PayPal",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/paypal/icon.png",
    "promotional_text": "Pay easily with PayPal."
  }
]
```

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

### Initialize EBANX.js

Source: https://docs.ebanx.com/docs/payments/guides/features/tokenization/tokenization

Initialize the EBANX.js library with your public integration key, the customer's country code, and the operating mode (test or production).

```javascript
EBANX.init({
  publicIntegrationKey: '{your_public_integration_key}',
  country: '{country_code_here}',
  mode: 'test',
});
```

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

### Example Digital Wallet Response

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/argentina/digital-wallets-argentina

This is a sample JSON response from the EBANX API listing available digital wallets for a given country, including their code, name, icon URL, and promotional text.

```json
[
  {
    "code": "nequi",
    "name": "Nequi",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png",
    "promotional_text": "This is promotional text"
  },
  {
    "code": "paypal",
    "name": "PayPal",
    "icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/paypal/icon.png",
    "promotional_text": "Pay easily with PayPal."
  }
]
```

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

### Get EBANX Available Banks (Curl)

Source: https://docs.ebanx.com/api

Fetches a list of all available banks, categorized by country, using the EBANX API. This is a POST request made via cURL.

```curl
curl -X POST 'https://sandbox.ebanx.com/ws/payout/banks'
```

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

### Get Transaction Hash or Merchant Payment Code

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/debit-cards

Retrieve the 'hash' or 'merchant_payment_code' from a pending EBANX transaction response. This identifier is crucial for subsequent payment capture operations.

```JSON
{
  "payment": {
    "hash": "59ad5f00945fa382ab051651440826da7701533249b3a475",
    "country": "br",
    "merchant_payment_code": "ecc9be4512a",
    "order_number": null,
    "status": "PE",
    ...
  }
}
```

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

### EBANX Get Bank List Request

Source: https://docs.ebanx.com/api

Queries EBANX to obtain a list of banks available for processing payments within a specified country. This operation is intended for server-to-server communication.

```JSON
{
  "integration_key": "your_test_integration_key",
  "operation": "request",
  "country": "co"
}
```

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

### Render Digital Wallet Options in HTML

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/uruguay/digital-wallets-uruguay

Example HTML structure to display digital wallet logos and promotional text retrieved from the EBANX API on a checkout page.

```html
<div class="digital-wallet">  
    <img src="https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png" alt="Nequi">  
    <p>Nequi: Fast and secure payments.</p>  
  </div>
```

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

### Get FX Rate - Response Sample

Source: https://docs.ebanx.com/api

This sample shows a successful response from the EBANX API when requesting an FX rate. It includes the exchange rate details and the transaction status.

```json
{
  "currency_rate": {
    "code": "USD",
    "base_code": "BRL",
    "name": "Real to US Dollar",
    "rate": "2.7731"
  },
  "status": "SUCCESS"
}
```

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

### Authenticate Payment with EBANX SDK

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/cards-3ds-2

Call the `EBANX.threeDSecure.authenticate` method with the prepared order, payment, and personal identification objects. Handle the promise to get authentication data or catch errors.

```JavaScript
const options = {
  orderInformation,
  paymentInformation,
  personalIdentification,
};

EBANX.threeDSecure.authenticate(options)
  .then((authenticationData) => {
    // Use authenticationData in your `Create Payment` API request.
  })
  .catch((error) => {
    // Handle Errors
  });

```

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

### Render Digital Wallet Options in HTML

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/chile/digital-wallets-chile

Example HTML structure to display digital wallet logos and promotional text retrieved from the EBANX API on a checkout page.

```html
<div class="digital-wallet">  
    <img src="https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png" alt="Nequi">  
    <p>Nequi: Fast and secure payments.</p>  
  </div>
```

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

### Render Digital Wallet Options in HTML

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/brazil/digital-wallets-brazil

Example HTML structure to display digital wallet logos and promotional text retrieved from the EBANX API on a checkout page.

```html
<div class="digital-wallet">  
    <img src="https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png" alt="Nequi">  
    <p>Nequi: Fast and secure payments.</p>  
  </div>
```

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

### Initialize EBANX.js

Source: https://docs.ebanx.com/docs/payments/guides/features/doc-check

Initialize the EBANX object with your public integration key, the customer's country code, and the operating mode (test or production). This setup is crucial before making any EBANX API calls.

```javascript
EBANX.init({
  publicIntegrationKey: '{your_public_integration_key}',
  country: '{country_code_here}',
  mode: 'test',
});
```

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

### Embed Authentication Data in Older JavaScript

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/cards-3ds-2

Provides an example of how to include 3DS authentication parameters in the payment.card object using older JavaScript syntax for EBANX Direct API requests.

```JavaScript
// payment.card object in your EBANX Direct API request  
  
"payment" : {
  "card": {
      "card_number": 4000000000001000,
      "card_name": "JOAO DA SILVA",
      "card_due_date": "12/2034",
      "card_cvv": "123",
      "threeds_eci": "05",
      "threeds_cryptogram": "AAIBAkl0NwmHglFBAXQ3AAAAAAA",
      "threeds_xid": "AAIBAkl0NwmHglFBAXQ3AAAAAAA",      
      "threeds_version": "2",                            
      "threeds_trxid": "aefd0ad3-697d-46b2-97fe-f5594f4edf80"
      }
}
```

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

### EBANX Enrollment Status Update Notification

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/brazil/pix-automatico/variable-enrollments

Example JSON payload for an EBANX enrollment status update notification. Indicates a change in enrollment status, typically from 'pending' to 'accepted'.

```json
{
   "operation":"enrollment_status_change",
   "notification_type":"update",
   "merchant_enrollment_code":"{{unique_enrollment_code}}"
}
```

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

### EBANX Get Available E-wallets Request

Source: https://docs.ebanx.com/api

This snippet demonstrates the request payload to retrieve a list of available e-wallets for a specific country. It requires the integration key and the two-letter country code.

```json
{
  "integration_key": "your_test_integration_key",
  "country": "co"
}
```

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

### Pagosnet Payment Response Example

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/bolivia/pagosnet

Example response from the EBANX API after a Pagosnet payment request. Includes payment details such as status, due date, and the crucial voucher_url for customer redirection.

```JSON
{
  "payment": {
    "hash": "6746074f71526c3d2c0374bcf1944305a2f48926c6a3e342",
    "country": "bo",
    "merchant_payment_code": "0x0W28D03-BO-T02",
    "order_number": null,
    "status": "PE",
    "status_date": null,
    "open_date": "2024-12-06 20:55:41",
    "confirm_date": null,
    "transfer_date": null,
    "amount_br": "100.00",
    "amount_ext": "100.00",
    "amount_iof": "0.00",
    "amount_ext_requested": "100.00",
    "currency_rate": "1.0000",
    "currency_ext": "BOB",
    "due_date": "2024-12-09",
    "instalments": "1",
    "payment_type_code": "pagosnet",
    "voucher_url": "https://sandbox.ebanx.com/print/voucher/execute?hash=6746074f71526c3d2c0374bcf1944305a2f48926c6a3e342",
    "pre_approved": false,
    "capture_available": null,
    "customer": {
      "document": "",
      "email": "joseperu@example.com",
      "name": "JOSE SILVA",
      "birth_date": null
    },
    "single_transaction": {
      "amount_local": "0.00",
      "amount_crossborder": "100.00"
    }

  },
  "status": "SUCCESS"
}

```

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

### Get FX Token - Response Sample

Source: https://docs.ebanx.com/api

This sample shows a successful response when retrieving an FX token. It includes the FX token, the exchange rate, currency details, and expiration information.

```json
{
  "fx_token": "sandbox.20171025.USD.COP",
  "currency_rate": 3.6,
  "currency_from": "USD",
  "currency_to": "COP",
  "expire_date": "2017-10-25T10:59:59+00:00",
  "new_currency_rate_available_at": "2017-10-25T09:00:00+00:00"
}
```

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

### Ebanx Mobile Money API Endpoint

Source: https://docs.ebanx.com/docs/payments/guides/accept-payments/api/kenya/mobile-money-ke

This snippet shows the base URL for initiating Mobile Money transactions through the EBANX API. It distinguishes between the sandbox environment for testing and the production environment for live transactions.

```HTTP
https://sandbox.ebanx.com/ws/direct
```

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

### Cancel Refund Request (cURL)

Source: https://docs.ebanx.com/api

This cURL example shows how to cancel an existing refund using the EBANX API. It requires the integration key, the payment hash, and the specific refund ID to be cancelled.

```curl
curl -X POST https://api.ebanx.com/ws/refund \
-H "Content-Type: application/json" \
-d '{ 
  "integration_key": "your_test_integration_key",
  "operation": "cancel",
  "hash": "5ad9028b30eb8de099f9fe72b9763283c7cf4d35b6430221",
  "refund_id": 3784756
}'
```