EBANX Gateway Guide

EBANX fact sheet

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.

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_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_field>payment_type_code</gateway_specific_field>
    <gateway_specific_field>notification_url</gateway_specific_field>
    <gateway_specific_field>merchant_payment_code</gateway_specific_field>
    <gateway_specific_field>payment_taxes_iva_co</gateway_specific_field>
    <gateway_specific_field>merchant_enrollment_code</gateway_specific_field>
    <gateway_specific_field>subscription_name</gateway_specific_field>
    <gateway_specific_field>expiration_date</gateway_specific_field>
    <gateway_specific_field>frequency</gateway_specific_field>
    <gateway_specific_field>retry</gateway_specific_field>
    <gateway_specific_field>max_amount_floor</gateway_specific_field>
    <gateway_specific_field>fixed_amount</gateway_specific_field>
    <gateway_specific_field>start_date</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, Pix Automatico & Mercado Pago
`zip`	Boleto Bancario, Pix, Pix Automatico & Mercado Pago
`city`	Boleto Bancario, Pix, Pix Automatico & Mercado Pago
`state`	Boleto Bancario, Pix, Pix Automatico & Mercado Pago
`phone_number`	Boleto Bancario, Pix, Pix Automatico & Mercado Pago
`address1`	Boleto Bancario, Pix, Pix Automatico & 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/json' \
 -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"
      }
    }
  }'

Pix Automatico

Spreedly supports Pix Automatico recurring payments using Ebanx. Make sure you have Pix Automatico configured as a supported payment method with your Ebanx account, including notifications of enrollment. The general steps are as follows:

Step 1: Enrollment

This is an example request body to perform an enrollment agreement required by Pix Automatico. Spreedly supports both Fixed and Variable Enrollments as well as Instant Payment + Enrollment.

In the response, Spreedly returns a checkout_url along with a Raw QR Code GSRF. The merchant can redirect their customer to the Pix Automatico checkout URL to accept or deny the enrollment agreement or display the QR code to their user to scan with their banking app.

Once the user accepts the enrollment agreement, EBANX sends the updated enrollment transaction status to Spreedly via a webhook Spreedly then updates the transaction with the latest status and, after doing so, triggers the callback_url provided in the original enrollment transaction to notify the merchant of the status update.

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

Step 1: Enrollment Request Using Verify

//JSON

curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/verify.json \
 -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqynYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
 -H 'Content-Type: application/json' \
 -d '{
{
  "transaction": {
    "payment_method": {
        "payment_method_type": "pix_automatico",
        "full_name": "full name",
        "document_id": "12335",
        "country_code": "BR",
        "email": "[email protected]"
    },
    "gateway_specific_fields": {
      "ebanx": {
        "merchant_enrollment_code": "123-456-789-dfdfdfd",// mandatory
        "subscription": {
          "subscription_name": "Descriptor of the subscription.",// mandatory
            "expiration_date": "2025-12-30",// optional
            "frequency": "monthly",// mandatory
            "retry": "allow_3R_7D",// mandatory
          "fixed_amount": 100.00, // mandatory field for fixed amount enrollment
           "max_amount_floor": 100.00, // mandatory field for variable amount enrollment
            "start_date": "2025-10-02"
        }
      }
    },
    "callback_url": "https://your-domain.com/callback"
  }
}
}'

{
    "transaction": {
        "on_test_gateway": true,
        "created_at": "2025-09-29T04:35:51Z",
        "updated_at": "2025-09-29T04:35:55Z",
        "succeeded": false,
        "state": "processing",
        "token": "FSgW16Q9OXLG4QHCwLWyOTpDWpx",
        "transaction_type": "Verification",
        "order_id": null,
        "ip": null,
        "description": null,
        "email": null,
        "merchant_name_descriptor": null,
        "merchant_location_descriptor": null,
        "merchant_profile_key": null,
        "gateway_specific_fields": {
            "ebanx": {
                "merchant_enrollment_code": "123-456-789-dfdfdfd",
                "subscription": {
                    "subscription_name": "Descriptor of the subscription.",
                    "expiration_date": "2025-12-30",
                    "frequency": "monthly",
                    "retry": "allow_3R_7D",
                    "max_amount_floor": 100,
                    "start_date": "2025-10-02"
                },
                "notification_url": "http://core.spreedly.test/transaction/FSgW16Q9OXLG4QHCwLWyOTpDWpx/callback"
            }
        },
        "gateway_specific_response_fields": {
            "ebanx": {
                "pix_automatico_qr_code": "00020101021226780014br.gov.bcb.pix2556fake-pix.com.br/qr/v2/ACA4311F88661BC0D48200487EF1BCD95204000053039865802BR5910FAKEPIX Ltda6008CURITIBA62070503***18663",
                "enrollment_status": "pending"
            }
        },
        "gateway_transaction_id": null, # NO gateway transaction ID in this case
        "gateway_latency_ms": 1184,
        "currency_code": null,
        "retain_on_success": false,
        "payment_method_added": false,
        "stored_credential_final_payment": false,
        "message_key": "messages.transaction_processing",
        "message": "Processing",
        "gateway_token": "29TBCAD7P18WVV1E5G0DANV3YT",
        "gateway_type": "ebanx",
        "response": {
            "success": true,
            "message": "Finish enrolling by responding to the enrollment agreement.",
            "pending": true,
            ...
            "checkout_url": "https://sandbox.ebanx.com/ewallet/recurrency-agreement?return_url=https%3A%2F%2Fsandbox.ebanx.com%2Fws%2Fcustomerenrollment-finish%2Ffake%3Fenrollment%3DNDYxMDM6MTIzLTQ1Ni03ODktZGZkZmRmZA%253D%253D&enrollment_uuid=DNKmaBb6M3jVybFpdgBge2"
        },
        "shipping_address": {
            "name": "full name",
        },
        "redirect_url": "https://your-domain.com/success",
        "callback_url": "https://your-domain.com/callback",
        "attempt_3dsecure": false,
        "challenge_url": null,
        "required_action": "none",
        "three_ds_context": null,
        "payment_method": {
            ...
        }
    }
}

Step 2: Payment Using Purchase

To create a payment, utilize the Purchase endpoint.

//JSON

 curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.json \
 -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
 -H 'Content-Type: application/xml' \
-d '{
{
	transaction: {
  payment_method_token: "{{pm_token}}",
  amount: 100,
  currency_code: "BRL",
  gateway_specific_fields: {
     ebanx: {
       merchant_payment_code: "123-456-678", //unique payment code from merchant
       merchant_enrollment_code: "mer", //Merchant enrollment code which was used during initial enrollement 
       due_date: "17/10/2025", //this has an alternative date format to be aware of
    }
  },
  callback_url: 'https://example.com',
  }
}'

{
    "transaction": {
        "on_test_gateway": true,
        "created_at": "2025-09-29T08:49:21Z",
        "updated_at": "2025-09-29T08:49:23Z",
        "succeeded": false,
        "state": "processing",
        "token": "ko7N87f4g9jzpflhnt3Megx2ri",
        "transaction_type": "OffsitePurchase",
        "gateway_specific_fields": {
            "ebanx": {
                "document": "98765432100",
                "merchant_payment_code": "123-456-678",
                "merchant_enrollment_code": "123-456-789-dfdfdfd",
                "due_date": "02/10/2025"
            }
        },
        "gateway_specific_response_fields": {
            "ebanx": {
                "amount_br": "1.04",
                "amount_ext": "1.00",
                "amount_iof": "0.04",
                "currency_rate": "1.0000",
                "currency_ext": "BRL",
                "retries": {
                  "retry_status": "LOCKED",
                  "available_retries": 3,
                  "payment_attempts": [
                      {
                          "attempted_at": "2025-09-29 09:00:54",
                          "attempt_response": "PENDING"
                      }
                  ]
              },
            }
        },
        "gateway_transaction_id": "68da481403386311ae327dedf2e3a493e467b73407cbd2f4",
        "sub_merchant_key": null,
        "gateway_latency_ms": 1179,
        "amount": 100,
        "local_amount": null,
        "currency_code": "BRL",
        "reference": "68da481403386311ae327dedf2e3a493e467b73407cbd2f4",
        "setup_verification": null,
        "expiration_date": "2025-10-02 00:00:00 +0530",
        "stored_credential_final_payment": false,
        "retain_on_success": false,
        "message_key": "messages.transaction_processing",
        "message": "Processing",
        "gateway_token": "29TBCAD7P18WVV1E5G0DANV3YT",
        "gateway_type": "ebanx",
        "response": {
            "success": true,
            "message": "Setup completed",
            ...
            "checkout_url": "https://sandbox.ebanx.com/ws/redirect?hash=68da481403386311ae327dedf2e3a493e467b73407cbd2f4"
        },
        "api_urls": [],
        "attempt_3dsecure": false,
        "challenge_url": null,
        "required_action": "none",
        "three_ds_context": null,
        "setup_response": {
            "success": true,
            "message": "Setup completed",
            ...
            "checkout_url": "https://sandbox.ebanx.com/ws/redirect?hash=68da481403386311ae327dedf2e3a493e467b73407cbd2f4"
        },
        "callback_url": null,
        "payment_method": {
            ...
        }
    }
}

Instant Payment + Enrollment

To create an Instant Payment + Enrollment pass gateway specific fields merchant_enrollment_code & subscription in the Payment (Purchase) request with Spreedly. A standard Payment does not require enrollment details like subscription.

//JSON

{
  "transaction": {
    "payment_method_token": "P9SWFjDZ4fuzntaprDIcpNiTOir",
    "gateway_specific_fields": {
      "ebanx": {
        "merchant_payment_code": "123-456-789-111",// mandatory
        "merchant_enrollment_code": "123-456-789-aaa",
        "subscription": {
          "subscription_name": "Descriptor of the subscription.",// mandatory
          "expiration_date": "2025-12-30",// optional
          "frequency": "monthly",// mandatory
          "retry": "allow_3R_7D",// mandatory
          "fixed_amount": 1000, // mandatory field for fixed amount enrollment
          "max_amount_floor": 1000, // mandatory field for variable amount enrollment
          "start_date": "2025-10-02"// mandatory
        },
        "due_date": "02/10/2025"
      }
    },
    "callback_url": "https://your-domain.com/callback"
  }
}

{
    "transaction": {
        "on_test_gateway": true,
        "created_at": "2025-10-15T10:56:59Z",
        "updated_at": "2025-10-15T10:57:00Z",
        "succeeded": false,
        "state": "processing",
        "token": "3xWJaV80XkWCDQvyQoeBiOzr1yK",
        "transaction_type": "OffsitePurchase",
        ...
        "gateway_specific_fields": {
            "ebanx": {
                "merchant_payment_code": "123-456-789-111",
                "merchant_enrollment_code": "123-456-789-aaa",
                "subscription": {
                    "subscription_name": "Descriptor of the subscription.",
                    "expiration_date": "2025-12-30",
                    "frequency": "monthly",
                    "retry": "allow_3R_7D",
                    "max_amount_floor": 10000,
                    "start_date": "2025-10-17"
                },
                "due_date": "17/10/2025"
            }
        },
        "gateway_specific_response_fields": {
            "ebanx": {
                "amount_br": "1.04",
                "amount_ext": "1.00",
                "amount_iof": "0.04",
                "currency_rate": "1.0000",
                "currency_ext": "BRL",
                "enrollment_status": "pending",
                "payment_status": "PE"
            }
        },
        "gateway_transaction_id": "68ef7dfbafaea50911d22829ae2fe8935964006934a0ffa7",
        ...
        "amount": 100,
        "local_amount": null,
        "currency_code": "BRL",
        "reference": "68ef7dfbafaea50911d22829ae2fe8935964006934a0ffa7",
        ...
        "retain_on_success": false,
        "message_key": "messages.transaction_processing",
        "message": "Processing",
        "gateway_token": "4RCFFMFQAF9EZBKGPDX0T9PSC3",
        "gateway_type": "ebanx",
        "response": {
            "success": true,
            "message": "Setup completed",
            ...
            "status": null,
            "checkout_url": "https://sandbox.ebanx.com/ws/simulator/confirm?hash=68ef7dfbafaea50911d22829ae2fe8935964006934a0ffa7"
        },
        "shipping_address": {
            ...
        },
        ...
        "setup_response": {
            "success": true,
            "message": "Setup completed",
            ...
            "status": null,
            "checkout_url": "https://sandbox.ebanx.com/ws/simulator/confirm?hash=68ef7dfbafaea50911d22829ae2fe8935964006934a0ffa7"
        },
        "callback_url": null,
        "payment_method": {
            ...
        }
    }
}

Void

In the case of Instant Payment + Enrollment, pass the gateway-specific field void_enrollment to void the enrollment. If this field is not passed, the payment will be voided instead.

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 instalments can be sent with the instalments gateway specific field.

The payment_type_code field can be used to indicate the credit card scheme. Optional examples: amex, aura, diners, discover, elo, hipercard, mastercard, visa.

The notification_url field can be used to send notifications for this payment. If this field is filled, EBANX will notify using this URL instead of the configured one.

The merchant_payment_code is an optional field that specifies the Merchant Payment Code (unique merchant ID). In the absence of an explicit merchant_payment_code field, Spreedly will supply the transaction's order_id in its place.

The payment_taxes_iva_co field can be used to send Colombia Local Tax details.

PIX AUTOMATICO

The merchant_enrollment_codeis a unique enrollment code that should be passed by the customer when generating enrollment.

Subscriptionis an object that contains the following GSFs, frequency: The billing cycle of the enrollment. Available frequencies are: weekly, monthly, quarterly, halfyearly, yearly.

retry: Determines whether the merchant will retry payments that fail on the expected billing day. The available retry policies are: not_allowed for no additional attempts or allow_3R_7D for up to three retries within seven days after the first payment

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>
            <gateway_specific_field>merchant_enrollment_code</gateway_specific_field>
            <subscription_name>subscription_name</subscription_name>
            <expiration_date>expiration_date</expiration_date>

            <retry>retry</retry>
            <max_amount_floor>max_amount_floor</max_amount_floor>
            <fixed_amount>fixed_amount</fixed_amount>
            <start_date>start_date</start_date>

            <metadata>
              <metadata_1>test</metadata_1>
              <metadata_2>test2</metadata_2>
            </metadata>
            <processing_type>local</processing_type>
            <soft_descriptor>Spreedly</soft_descriptor>
            <payment_type_code>visa</payment_type_code>
            <notification_url>https://notify.example.com/</notification_url>
            <merchant_payment_code>12345</merchant_payment_code>
          </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>
      <merchant_enrollment_code>merchant_enrollment_code</merchant_enrollment_code>
      <subscription_name>subscription_name</subscription_name>
      <expiration_date>expiration_date</expiration_date>
      <frequency>frequency</frequency>
      <retry>retry</retry>
      <max_amount_floor>max_amount_floor</max_amount_floor>
      <fixed_amount>fixed_amount</fixed_amount>
      <start_date>start_date</start_date>
      <metadata>
        <metadata_1>test</metadata_1>
        <metadata_2>test2</metadata_2>
      </metadata>
      <processing_type>local</processing_type>
      <soft_descriptor>Spreedly</soft_descriptor>
      <payment_type_code>visa</payment_type_code>
      <notification_url>https://notify.example.com/</notification_url>
      <merchant_payment_code>12345</merchant_payment_code>
    </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"/>
  <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:

For refund transactions, the additional refund_id may be returned as a gateway specific response field.

<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>
      <enrollment_status>enrollment_status</enrollment_status>
      <pix_automatico_qr_code>pix_automatico_qr_code</pix_automatico_qr_code>

      <transaction_status>
        <description>Accepted<description>
        <code>OK<code>
        <authcode>12345<authcode>
        <acquirer>EBANX<acquirer>
      </transaction_status>
    </ebanx>
  </gateway_specific_response_fields>
</transaction>

Syncing transactions

Spreedly supports updating the status of transactions that have been initiated at the Ebanx gateway. Ebanx currently only supports using gateway_transaction_id for updates which would be the id of the transaction. See our documentation for more information.