Version: current

SPEI with Direct API

About this guide

This page explains how to add SPEI to your existing Direct API integration. Direct API integration is basically the same for all payment methods, only varying the payment_type_code and some additional required fields.

If you are not integrated with EBANX Direct API yet, please take a look in this basic guide about it. Are you not sure if EBANX Direct API is the best option for your e-commerce? Please, talk with one of our integration specialists.

What you will need

Before starting your integration, please make sure that you have:

  1. An EBANX Sandbox account. That's not the case? Please sign up for an Sandbox Account here;
  2. SPEI enabled in your EBANX Dashboard.

How it works

To complete SPEI integration throught EBANX Direct API, please follow the steps below.

  1. Enable SPEI

    SPEI availability may vary depending on your contract. So the first step is to check if it is active in your EBANX dashboard.

    All set? We can go ahead to next step, otherwise, please get in touch with our integration specialists.

  2. Call the /ws/direct end-point to get the SPEI link (server-side)

    SPEI works as a voucher, so you will need to redirect your customer to a page containing it. To get this link, you just need to call the end-point ws/direct (server-side) with the following required fields:

    Basic parameters:

    ParameterDescription
    operationOperation must be request
    integration_keyYour unique and secret integration key
    payment_type_codeTo SPEI must be spei
    countryTwo-letter country code - mx for Mexico.

    Customer data:

    ParameterDescription
    nameCustomer name
    emailCustomer e-mail
    phone_numberCustomer phone number

    Charge parameters:

    ParameterDescription
    merchant_payment_codeUnique merchant payment code
    currency_codeISO-4217 Currency code of your transaction. Supported values: MXN and USD
    amount_totalTotal amount to be charged

    Check the example:

    curl -L -X POST 'https://sandbox.ebanxpay.com/ws/direct' \
    -H 'Content-Type: application/json' \
    --data-raw '{
    "integration_key": "{{integration_key}}",
    "operation": "request",
    "payment": {
    "name": "Juan Garcia",
    "email": "juangarcia@example.com",
    "phone_number": "0405777687",
    "country": "mx",
    "payment_type_code": "spei",
    "merchant_payment_code": "0x0W28D03-T05",
    "currency_code": "MXN",
    "amount_total": "6000"
    }
    }'

    A successful request will return a JSON response like the one below. The voucher link will be in the parameter payment.spei_url, customer’s CLABE account will be the value of payment.clabe_account, and the reference for the current payment will be the value of payment.clabe_reference

    {
    "payment": {
    "hash": "5efcb917129a9a5a175e5c918fea0651ba6bf1e6fb6ae593",
    "pin": "088722858",
    "country": "mx",
    "merchant_payment_code": "0x0W28D03-T05",
    "order_number": null,
    "status": "PE",
    "status_date": null,
    "open_date": "2020-07-01 16:25:58",
    "confirm_date": null,
    "transfer_date": null,
    "amount_br": "6000.00",
    "amount_ext": "6000.00",
    "amount_iof": "0.00",
    "amount_ext_requested": "6000.00",
    "currency_rate": "1.0000",
    "currency_ext": "MXN",
    "due_date": "2020-07-04",
    "instalments": "1",
    "payment_type_code": "spei",
    "clabe_account": "000000000000000000",
    "clabe_reference": "0000000",
    "spei_url": "https://sandbox.ebanxpay.com/print/spei/execute?hash=5efcb917129a9a5a175e5c918fea0651ba6bf1e6fb6ae593",
    "pre_approved": false,
    "capture_available": null,
    "customer": {
    "document": "",
    "email": "juangarcia@example.com",
    "name": "JUAN GARCIA",
    "birth_date": null
    }
    },
    "status": "SUCCESS"
    }
    info

    The complete API reference for the end-point ws/direct can be found here. We strongly recommend you to take a look in all the available options.

  3. Redirect customer to the returned URL

    Redirect your customer to the URL returned in the parameter spei_url. Your customers will see an interface like this:

    SPEI

    At this point you have a pending payment in your EBANX Dashboard.

  4. Wait for the payment

    Once the voucher is payed by the customer, it will take sometime to EBANX get informed by SPEI. As soon as we get the confirmation, payment status is modified from pending to confirmed.

    If your customers don't conclude the payment, it will be automatically canceled.

Getting help

We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:

  • If you’re not our partner yet and would like to know more about our prices and conditions please fill ou this form and our comercial team will get in touch with you.
  • In case you’re already our partner please get in touch with our support team at integration@ebanx.com.
Last updated on by Fernando Pankiewicz Gomes