EBANX Gateway Guide

EBANX fact sheet

Additional notes

EBANX has specific requirements to successfully run certain transactions:

Additional notes
EBANX has specific requirements to successfully run certain transactions:
- A valid billing address is required for all transactions (except for Mexico). Brazil requires the state to be a two-letter code. Be sure to include a billing address when creating payment methods for Spreedly to forward along to your EBANX transactions. - For any transactions in Colombia, Brazil, Chile, or Argentina, EBANX requires a taxpayer identification number sent in the `document` field. If the customer is a company, the `person_type` gateway specific field must be sent as `business`, and the `responsible_name` field must be provided. - Store actions require a two-letter country code sent in the `country` gateway specific field. - Refunds require a description. You can send a refund description via the `description` gateway specific field. Spreedly does not currently support a default description field on refunds. - Pre-authorizations are not available in Colombia - An email address must be passed for every `authorize` or `purchase` call. Please ensure you have set the `email` property on any payment method being used on an EBANX gateway or pass it in as a parameter in the `authorize` or `purchase` call. Transactions that do not have an email will fail with a message of “Field payment.email is required”

- A valid billing address is required for all transactions (except for Mexico). Brazil requires the state to be a two-letter code. Be sure to include a billing address when creating payment methods for Spreedly to forward along to your EBANX transactions.

- For any transactions in Colombia, Brazil, Chile, or Argentina, EBANX requires a taxpayer identification number sent in the document field. If the customer is a company, the person_type gateway specific field must be sent as business, and the responsible_name field must be provided.
- Store actions require a two-letter country code sent in the country gateway specific field.
- Refunds require a description. You can send a refund description via the description gateway specific field. Spreedly does not currently support a default description field on refunds.
- Pre-authorizations are not available in Colombia
- An email address must be passed for every authorize or purchase call. Please ensure you have set the email property on any payment method being used on an EBANX gateway or pass it in as a parameter in the authorize or purchase call. Transactions that do not have an email will fail with a message of “Field payment.email is required”

Adding an EBANX gateway

To add an EBANX gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>ebanx</gateway_type>
        <integration_key>Your integration_key</integration_key>
      </gateway>'

<gateway>
  <token>K0ditDqMruKYmuHLe74EeqSG1ms</token>
  <gateway_type>ebanx</gateway_type>
  <name>EBANX</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">true</supports_authorize>
    <supports_capture type="boolean">true</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_adjust type="boolean">false</supports_adjust>
    <supports_verify type="boolean">true</supports_verify>
    <supports_reference_purchase type="boolean">false</supports_reference_purchase>
    <supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
    <supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
    <supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
    <supports_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
    <supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_authorize>
    <supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
    <supports_3dsecure_2_mpi_purchase type="boolean">false</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">false</supports_3dsecure_2_mpi_authorize>
    <supports_store type="boolean">true</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_network_tokenization type="boolean">true</supports_network_tokenization>
    <supports_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
    <supports_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
    <supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
    <supports_transaction_retry type="boolean">false</supports_transaction_retry>
    <supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
  </characteristics>
  <credentials>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>document</gateway_specific_field>
    <gateway_specific_field>description</gateway_specific_field>
    <gateway_specific_field>birth_date</gateway_specific_field>
    <gateway_specific_field>instalments</gateway_specific_field>
    <gateway_specific_field>country</gateway_specific_field>
    <gateway_specific_field>person_type</gateway_specific_field>
    <gateway_specific_field>responsible_name</gateway_specific_field>
    <gateway_specific_field>responsible_document</gateway_specific_field>
    <gateway_specific_field>responsible_birth_date</gateway_specific_field>
    <gateway_specific_field>include_capture_amount</gateway_specific_field>
    <gateway_specific_field>device_id</gateway_specific_field>
    <gateway_specific_field>metadata</gateway_specific_field>
    <gateway_specific_field>processing_type</gateway_specific_field>
    <gateway_specific_field>soft_descriptor</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>third_party_token</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <sandbox type="boolean">false</sandbox>
  <mode>default</mode>
  <created_at type="dateTime">2023-01-04T20:07:40Z</created_at>
  <updated_at type="dateTime">2023-01-04T20:07:40Z</updated_at>
</gateway>

Local payment methods

Certain fields are required when making a transaction using local payment methods such as Pix, Boleto Bancario, Oxxo or Mercado Pago.

Fields	Required on
`email`	required for all
`document_id`	Boleto Bancario, Pix & Mercado Pago
`zip`	Boleto Bancario, Pix & Mercado Pago
`city`	Boleto Bancario, Pix & Mercado Pago
`state`	Boleto Bancario, Pix & Mercado Pago
`phone_number`	Boleto Bancario, Pix & Mercado Pago
`address1`	Boleto Bancario, Pix & Mercado Pago

Optional fields	Required on
`expiration_time_in_seconds`	Pix
`due_date`	Boleto Bancario

Mercado pago recurring

Spreedly supports Mercado Pago recurring payments using Ebanx. The general steps are as follows:

Step 1: Enrollment

This is an example request body to perform an enrollment agreement required by Mercado Pago. The recurring field indicates that this a recurring payment method and is only available for Mercado Pago.

In the response, Spreedly returns a checkout_url and the merchant must redirect their customer to that Mercado Pago checkout URL to accept or deny the enrollment agreement.

To cancel the enrollment the merchant must perform a void request on this Verification.

curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/verify.json \
 -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
 -H 'Content-Type: application/xml' \
 -d '{
    {
      "transaction": {
        "payment_method": {
            "email": "[email protected]",
            "payment_method_type": "mercado_pago",
            "full_name": "Full Name",
            "document_id": "71575743221",
            "country": "BR",
            "zip": "12345",
            "address1": "1234 test ave",
            "city": "Rio",
            "state": "CE",
            "phone_number": "8522847035",
            "recurring": true
        },
        "gateway_specific_fields": {
            "ebanx": {
                "merchant_enrollment_code": "12345"
            }
        }
      }
    }
  }'

Step 2: Purchase

curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.json \
 -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
 -H 'Content-Type: application/xml' \
 -d '{
    {
      "transaction": {
        "payment_method_token": "2ujzhvLJXwuXAVXC8nHE3bvPbgH",
        "amount": 100,
        "currency_code": "USD",
        "callback_url": "https://example.com",
        "redirect_url": "https://example.com"
      }
    }
  }'

Gateway specific fields

When making a transaction, you can specify a number of gateway specific fields. Some are required in certain situations:

For any transactions in Colombia, Brazil, Chile, or Argentina, EBANX requires a taxpayer identification number sent in the document field. If the customer is a company rather than an individual, the person_type gateway specific field must be sent as business, and the responsible_name must be provided.

By default, the amount is not sent to EBANX for capture requests, and the full amount reserved from the authorization is captured. To have the capture amount included, send an include_capture_amount gateway specific field with the value true with the capture request. This is necessary for partial captures (only available in Brazil).

When refunding with EBANX, a description field is necessary. Spreedly does not support a default description like with purchase or authorize for refund requests so it must be passed as a gateway specific field.

When storing a card with EBANX, a two-letter country code must be sent in the country gateway specific field.

The device_id field can be used for device fingerprinting, which is used by anti-fraud tools.

The processing_type field is used to denote whether a transaction is a cross-border payment. Use this field with a value of local to indicate that the transaction is not a cross-border payment.

The soft_descriptor field can optionally be sent with purchase or authorize requests.

A number of payment installments can be sent with the installments gateway specific field.

Country	Available installments
Argentina	2, 3, 6, 9, or 12
Brazil	1 … 12
Chile	1 ... 48
Colombia	1 ... 36
Mexico	3, 6, 9, or 12
Peru	1 ... 48

These fields can be sent as below:

curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
          <ebanx>
            <document>taxpayer ID</document>
            <birth_date>01/01/1990</birth_date>
            <instalments>3</instalments>
            <description>Reason for Refund</description>
            <person_type>business</person_type>
            <responsible_name>Responsible Person</responsible_name>
            <responsible_document>Responsible Document Number</responsible_document>
            <responsible_birth_date>dd/mm/yyyy</responsible_birth_date>
            <device_id>34c376b2767</device_id>
            <metadata>
              <metadata_1>test</metadata_1>
              <metadata_2>test2</metadata_2>
            </metadata>
            <processing_type>local</processing_type>
            <soft_descriptor>Spreedly</soft_descriptor>
          </ebanx>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2023-01-04T20:05:15Z</created_at>
  <updated_at type="dateTime">2023-01-04T20:05:15Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>PQuOdHneFkeRwjfUpBzlSzaoOZb</token>
  <transaction_type>Purchase</transaction_type>
  <order_id nil="true"/>
  <ip nil="true"/>
  <description nil="true"/>
  <email nil="true"/>
  <merchant_name_descriptor nil="true"/>
  <merchant_location_descriptor nil="true"/>
  <merchant_profile_key nil="true"/>
  <gateway_specific_fields>
    <ebanx>
      <document>taxpayer ID</document>
      <birth_date>01/01/1990</birth_date>
      <instalments>3</instalments>
      <description>Reason for Refund</description>
      <person_type>business</person_type>
      <responsible_name>Responsible Person</responsible_name>
      <responsible_document>Responsible Document Number</responsible_document>
      <responsible_birth_date>dd/mm/yyyy</responsible_birth_date>
      <device_id>34c376b2767</device_id>
      <metadata>
        <metadata_1>test</metadata_1>
        <metadata_2>test2</metadata_2>
      </metadata>
      <processing_type>local</processing_type>
      <soft_descriptor>Spreedly</soft_descriptor>
    </ebanx>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>45</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">0</gateway_latency_ms>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <warning nil="true"/>
  <application_id nil="true"/>
  <amount type="integer">100</amount>
  <local_amount nil="true"/>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <smart_routed type="boolean">false</smart_routed>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <gateway_type>test</gateway_type>
  <shipping_address>
    <name>Newfirst Newlast</name>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
  </shipping_address>
  <response>
    <success type="boolean">true</success>
    <message>Successful purchase</message>
    <avs_code nil="true"/>
    <avs_message nil="true"/>
    <cvv_code nil="true"/>
    <cvv_message nil="true"/>
    <pending type="boolean">false</pending>
    <result_unknown type="boolean">false</result_unknown>
    <error_code nil="true"/>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2023-01-04T20:05:15Z</created_at>
    <updated_at type="dateTime">2023-01-04T20:05:15Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
    <created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
    <updated_at type="dateTime">2022-12-29T15:31:25Z</updated_at>
    <email>[email protected]</email>
    <data>
      <my_payment_method_identifier>448</my_payment_method_identifier>
      <extra_stuff>
        <some_other_things>Can be anything really</some_other_things>
      </extra_stuff>
    </data>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <metadata>
      <key>string value</key>
    </metadata>
    <callback_url nil="true"/>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Newfirst</first_name>
    <last_name>Newlast</last_name>
    <month type="integer">3</month>
    <year type="integer">2032</year>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
    <company nil="true"/>
    <full_name>Newfirst Newlast</full_name>
    <eligible_for_card_updater type="boolean">true</eligible_for_card_updater>
    <shipping_address1 nil="true"/>
    <shipping_address2 nil="true"/>
    <shipping_city nil="true"/>
    <shipping_state nil="true"/>
    <shipping_zip nil="true"/>
    <shipping_country nil="true"/>
    <shipping_phone_number nil="true"/>
    <issuer_identification_number nil="true"/>
    <click_to_pay type="boolean">false</click_to_pay>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
    <stored_credential_usage>
      <test>
        <original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
        <network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
      </test>
    </stored_credential_usage>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Gateway specific response fields

A response from the gateway may contain the following gateway specific response fields:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
    <ebanx>
      <pix_qr_code>123456</pix_qr_code>
      <oxxo_barcode>123456</oxxo_barcode>
      <boleto_barcode_raw>123456</boleto_barcode_raw>
      <boleto_barcode>123456</boleto_barcode>
      <payment_type_code>creditcard</payment_type_code>
      <transaction_status>
        <description>Accepted<description>
        <code>OK<code>
        <authcode>12345<authcode>
        <acquirer>EBANX<acquirer>
      </transaction_status>
    </ebanx>
  </gateway_specific_response_fields>
</transaction>