Bank Transfer

  POST https://api-sandbox.epag.io/bankTransfer/simple

Overview

This process is designed to facilitate direct bank transfers in Ecuador, specifically through Banco Guayaquil. It optimizes the user experience by generating a payment code that customers can use to complete the transaction within their own online banking portal.

The process offers:

Immediate display of payment information to the payer. After the API call, a payment_code and clear instructions are returned. Your system can then display this information to the customer, who can use it to make the payment through their Banco Guayaquil account at their convenience. This avoids redirects and contributes to a smoother checkout experience.

To use this process, simply send the required fields as indicated in the documentation. The customer's email is the only personal data required.

Minimum and Maximum Amounts

Minimum Amount	Maximum Amount
1 USD	10,000 USD

Reference Checkout UI Bank Transfer

Input Email

View Transaction Information and Payment Instructions

Bank Transfer Flow

Authorization

Header	Value
X-Auth-Token	MY_ACCESS_TOKEN

Request description

• contract_id (required/string): Merchant's contract id.
• notification_url (required/string): URL to post callbacks to this payment.
• reference_id (required/string/max 45 chars): External code created by the merchant to reference this payment (e.g. order number).
• ip_address (optional/string): Remote IP Address(IPv4/IPv6).
• extra_data (optional/object): Optional extra data that you can use at transaction.
• payment (required/object): The payment data:
  • amount (required/float): Total amount of the payment. Value must have a maximum of two decimal places.
  • asset (required/string): Reference code for asset for the sale's amount. e.g. USD.
  • country (required/string): Country code in ISO 3166-2. e.g. EC.
  • currency (required/string): Currency code in ISO-4217. e.g. USD.
• person (required/object): The person data:
  • email (required/string): Person’s email provided to the merchant.

Response Description

• transaction_status (string): Current status of the payment.
• payment_token (string): Unique payment identification for this payment.
• refresh_token (string): Updated access token for future calls.
• reference_id (string): External code created by the merchant to reference this payment (e.g. order number).
• amount (string): Amount of this payment.
• payment_code (string): The code the payer must use in their bank portal to complete the payment.
• instructions (array of strings): A list of steps for the payer to follow to complete the payment.
• totals (object): The payment totals.
  • amount (float): Amount in default region asset.
  • asset (string): Asset used in this amount.
  • original_amount (float): Amount as informed by merchant.
  • original_asset (string): Asset used in this originalAmount.
  • customer_fees (float): Total calculated fee assigned to customer.
  • customer_amount (float): Total amount for customer (amount + customer_fees).
• customer_fees (object): List of incident customer fees and respective values.

Example Request

200 - Success

Example Request

200 - Success

    curl --location 'https://api-sandbox.epag.io/bankTransfer/simple' \
    --header 'X-Auth-Token: MY_ACCESS_TOKEN' \
    --data-raw '{
        "contract_id": "MY_CONTRACT_ID",
        "notification_url": "https://my.notification.url",
        "reference_id": "MY_REFERENCE_ID",
        "ip_address": "0.0.0.0",
        "payment": {
            "amount": 100.00,
            "asset": "USD",
            "country": "EC",
            "currency": "USD"
        },
        "person": {
            "email": "[email protected]"
        },
        "extra_data": {
            "my-conciliation-number": "xxxxxx"
        }
    }'

Example Response

Header

  Content-Type: application/json

Body

    {
      "transaction_status": "PROCESSING",
      "payment_token": "e5d5a308-7903-45e0-a1c4-7fc8783095de",
      "reference_id": "5ceb3199-ed5f-41b6-b6df-6a0bf960bf8a",
      "amount": "100.00",
      "totals": {
        "amount": 100,
        "original_amount": 100,
        "original_asset": "USD",
        "customer_fees": 0,
        "customer_amount": 100,
        "asset": "USD"
      },
      "customer_fees": {},
      "payment_code": "666438",
      "instructions": [
        "En tu Banca Virtual ingresa a Personas con tu usuario y clave. Selecciona Pago de Servicios.",
        "En Recaudaciones Empresariales busca [PAGOSEGURO] (sin espacios). Ingresa el Código de pago [666438].",
        "Selecciona la forma de pago y verifica el monto a pagar [US$ 100,00]",
        "Digita el código de seguridad, confirma el pago y ¡Listo!"
      ],
      "refresh_token": "MY_ACCESS_TOKEN"
    }