Create a payment for Argentina

This page's content:

Payment Page API

To create a payment using EBANX Payment Page, you must call the API method request.

The following parameters are mandatory for Argentina payment methods using EBANX Payment Page:

integration_key string

Your unique and secret integration key.

name string

Customer name.

email string

Customer email address.

country string

Two-letter country code ar for Argentina.

payment_type_code string

The customer chooses the payment method. Supported values:

_all: all available payment methods for the merchant account in this country.
rapipago: Rapipago.
pagofacil: PagoFacil.
cupon: Cupon de Pagos.
_creditcard: Credit Card.

merchant_payment_code string

Unique identifier for this payment (usually the order number from your system).

currency_code string

The currency code of your transaction. Supported values: ARS and USD

amount float

Transaction amount, in the specified currency. E.g.,: 100.50

curl Node.js PHP Ruby

Copy

curl -X POST 'https://sandbox.ebanxpay.com/ws/request' \
    -d 'integration_key=your_test_integration_key_here' \
    -d 'name=Random Name' \
    -d 'email=random@example.com' \
    -d 'country=ar' \
    -d 'payment_type_code=_all' \
    -d 'merchant_payment_code=4384df6c0c1' \
    -d 'currency_code=ARS' \
    -d 'amount=1000'

Copy

var module = require('ebanx');
var ebanx = new module();

ebanx.configure({
    integrationKey : "your_test_integration_key_here",
    testMode: true
});

var params = {
    name: "Random Name",
    email: "random@example.com",
    country: "ar",
    payment_type_code: "_all",
    merchant_payment_code: "fe7f425f2a6",
    currency_code: "ARS",
    amount_total: "100.00"
};

ebanx.request(params, function(err, reply) {
    if (err) {
        console.log(err);
    } else {
        console.log(reply);
    }
});

Copy

require 'vendor/autoload.php';

\Ebanx\Config::set([
    'integrationKey' => 'your_test_integration_key_here'
    , 'directMode' => false
    , 'testMode' => true
]);

\Ebanx\Ebanx::doRequest([
    'name' => 'Random Name'
    , 'email' => 'random@example.com'
    , 'country' => 'ar'
    , 'payment_type_code' => '_all'
    , 'merchant_payment_code' => '7d01c84ac5c'
    , 'currency_code' => 'ARS'
    , 'amount_total' => 100.00
]);

Copy

require 'ebanx'

Ebanx.tap do |e|
    e.integration_key = 'your_test_integration_key_here'
    e.test_mode = true
end

response = Ebanx.do_request({
    name: "Random Name",
    email: "random@example.com",
    country: "ar",
    payment_type_code: "_all",
    merchant_payment_code: "abbfcf7ae3d",
    currency_code: "ARS",
    amount_total: "100.00"
})

A successful request will return a JSON expression similar to the one below. You will need to redirect the customer to the EBANX Payment Page using the redirect_url.

Copy

{
  "payment": {
      "hash": "59c942332925125005a5bf36f2c95efd1813daad33c5676e",
      "pin": "977115934",
      "merchant_payment_code": "4384df6c0c1",
      "order_number": null,
      "status": "OP",
      "status_date": null,
      "open_date": "2017-09-25 17:51:47",
      "confirm_date": null,
      "transfer_date": null,
      "amount_br": 1000,
      "amount_ext": 1000,
      "amount_iof": 0,
      "amount_usd": "54.76",
      "currency_rate_usd": "18.2621",
      "currency_rate": 1,
      "currency_ext": "ARS",
      "due_date": "2017-09-28",
      "instalments": 1,
      "payment_type_code": "_all",
      "pre_approved": false,
      "capture_available": null,
      "customer": null
  },
  "redirect_url": "https:\/sandbox.ebanxpay.com\/checkout\/?hash=59c942332925125005a5bf36f2c95efd1813daad33c5676e",
  "status": "SUCCESS"
}

Direct API

Here’s a guide of User Experience that may help you in your integration with Argentine payments. CLICK HERE.

To create a payment using EBANX Direct, you must call the API method direct.

The following parameters are mandatory for Argentine payment methods using EBANX Direct:

integration_key string

Your unique and secret integration key.

payment.name string

Customer name.

payment.email string

Customer email address.

payment.document string

Customer CUIT / CUIL / CDI (taxpayer identification number). It must be a valid one. You can check our documentation about validation here

payment.phone_number string

Customer phone number with area code.

payment.country string

Two-letter country code ar for Argentina.

payment.payment_type_code string

The customer chooses the payment method. Supported values:

rapipago: Rapipago.
pagofacil: PagoFacil.
cupon: Cupon de Pagos.
_creditcard: Credit Card.

payment.merchant_payment_code string

Unique identifier for this payment (usually the order number from your system).

payment.currency_code string

The currency code of your transaction. Supported values: ARS and USD

payment.amount_total float

Transaction amount, in the specified currency. E.g.,: 100.50

RapiPago – Direct API

The following parameters are specific to the RapiPago payment method:

payment.payment_type_code string

The value must be rapipago for RapiPago payments.

curl Node.js PHP Ruby

Copy

curl -X POST 'https://sandbox.ebanxpay.com/ws/direct' \
    -d 'request_body={
    "integration_key": "your_test_integration_key_here",
    "operation": "request",
    "payment": {
    "name": "Random Name",
    "email": "random@example.com",
    "document": "23876543214",
    "address": "Boulevard Jorde",
    "street_number": "555",
    "city": "Moreno",
    "state": "BA",
    "zipcode": "15796",
    "phone_number": "0405777687",
    "country": "ar",
    "payment_type_code": "rapipago",
    "merchant_payment_code": "0564b3c5ae0",
    "currency_code": "ARS",
    "amount_total": "100"
    }
}'

Copy

var module = require('ebanx');
var ebanx = new module();

ebanx.configure({
    integrationKey : "your_test_integration_key_here",
    testMode: true
});

var params = {
    payment : {
        name : "Random Name",
        email : "random@example.com",
        document : "23876543214",
        address :"Boulevard Jorde",
        street_number : "555",
        city : "Moreno",
        state : "BA",
        zipcode : "15796",
        phone_number : "0405777687",
        country : "ar",
        payment_type_code : "rapipago",
        merchant_payment_code : "26cca8a952b",
        currency_code : "ARS",
        amount_total : "100.00"
    }
};

ebanx.direct(params, function(err, reply) {
    if (err) {
        console.log(err);
    } else {
        console.log(reply);
    }
});

Copy

require 'vendor/autoload.php';

\Ebanx\Config::set([
    'integrationKey' => 'your_test_integration_key_here'
    , 'directMode' => true
    , 'testMode' => true
]);

\Ebanx\Ebanx::doRequest([
    'mode' => 'full'
    , 'operation' => 'request'
    , 'payment' => [
        'name' => 'Random Name'
        , 'email' => 'random@example.com'
        , 'document' => '23876543214',
        , 'address' => 'Boulevard Jorde'
        , 'street_number' => '555'
        , 'city' => 'Moreno'
        , 'state' => 'BA'
        , 'zipcode' => '15796'
        , 'phone_number' => '0405777687'
        , 'country' => 'ar'
        , 'payment_type_code' => 'rapipago'
        , 'merchant_payment_code' => 'dde592395b5'
        , 'currency_code' => 'ARS'
        , 'amount_total' => 100
    ]
]);

Copy

require 'ebanx'

Ebanx.tap do |e|
    e.integration_key = 'your_test_integration_key_here'
    e.test_mode = true
end

response = Ebanx.do_direct({
    payment: {
        name: "Random Name",
        email: "random@example.com",
        document: "23876543214",
        address:"Boulevard Jorde",
        street_number: "555",
        city: "Moreno",
        state: "BA",
        zipcode: "15796",
        phone_number: "0405777687",
        country: "ar",
        payment_type_code: "rapipago",
        merchant_payment_code: "86a75049eb0",
        currency_code: "ARS",
        amount_total: "100.00"
    }
})

A successful request will return a JSON expression similar to the one below. You will need to redirect the customer to voucher_url.

Copy

{
  "redirect_url": null,
  "payment": {
    "hash": "59db70236b69fb43bb5767c10c01a1fed260eaba6b9c4c45",
    "pin": "672142428",
    "merchant_payment_code": "ba9631d85a5",
    "order_number": null,
    "status": "PE",
    "status_date": null,
    "open_date": "2017-10-09 12:48:35",
    "confirm_date": null,
    "transfer_date": null,
    "amount_br": "376.00",
    "amount_ext": "100.00",
    "amount_iof": "0.00",
    "currency_rate": "3.7600",
    "currency_ext": "USD",
    "due_date": "2017-10-12",
    "instalments": "1",
    "payment_type_code": "rapipago",
    "voucher_url": "https://sandbox.ebanxpay.com/print/voucher/execute?hash=59db70236b69fb43bb5767c10c01a1fed260eaba6b9c4c45",
    "pre_approved": false,
    "capture_available": null
  },
  "status": "SUCCESS"
}

PagoFacil – Direct API

The following parameters are specific to the PagoFacil payment method:

payment.payment_type_code string

the value must be pagofacil for PagoFacil payments.

curl Node.js PHP Ruby

Copy

curl -X POST 'https://sandbox.ebanxpay.com/ws/direct' \
    -d 'request_body={
    "integration_key": "your_test_integration_key_here",
    "operation": "request",
    "payment": {
      "name": "Random Name",
      "email": "random@example.com",
      "document": "23876543214",
      "address": "Boulevard Jorde",
      "street_number": "555",
      "city": "Moreno",
      "state": "BA",
      "zipcode": "15796",
      "phone_number": "0405777687",
      "country": "ar",
      "payment_type_code": "pagofacil",
      "merchant_payment_code": "0564b3c5ae0",
      "currency_code": "ARS",
      "amount_total": "100"
    }
}'

Copy

var module = require('ebanx');
var ebanx = new module();

ebanx.configure({
    integrationKey : "your_test_integration_key_here",
    testMode: true
});

var params = {
    payment : {
        name : "Random Name",
        email : "random@example.com",
        document: "23876543214",
        address :"Boulevard Jorde",
        street_number : "555",
        city : "Moreno",
        state : "BA",
        zipcode : "15796",
        phone_number : "0405777687",
        country : "ar",
        payment_type_code : "pagofacil",
        merchant_payment_code : "26cca8a952b",
        currency_code : "ARS",
        amount_total : "100.00"
    }
};

ebanx.direct(params, function(err, reply) {
    if (err) {
        console.log(err);
    } else {
        console.log(reply);
    }
});

Copy

require 'vendor/autoload.php';

\Ebanx\Config::set([
    'integrationKey' => 'your_test_integration_key_here'
    , 'directMode' => true
    , 'testMode' => true
]);

\Ebanx\Ebanx::doRequest([
    'mode' => 'full'
    , 'operation' => 'request'
    , 'payment' => [
        'name' => 'Random Name'
        , 'email' => 'random@example.com'
        , 'document' => '23876543214'
        , 'address' => 'Boulevard Jorde'
        , 'street_number' => '555'
        , 'city' => 'Moreno'
        , 'state' => 'BA'
        , 'zipcode' => '15796'
        , 'phone_number' => '0405777687'
        , 'country' => 'ar'
        , 'payment_type_code' => 'pagofacil'
        , 'merchant_payment_code' => 'dde592395b5'
        , 'currency_code' => 'ARS'
        , 'amount_total' => 100
    ]
]);

Copy

require 'ebanx'

Ebanx.tap do |e|
    e.integration_key = 'your_test_integration_key_here'
    e.test_mode = true
end

response = Ebanx.do_direct({
    payment: {
        name: "Random Name",
        email: "random@example.com",
        document: "23876543214",
        address:"Boulevard Jorde",
        street_number: "555",
        city: "Moreno",
        state: "BA",
        zipcode: "15796",
        phone_number: "0405777687",
        country: "ar",
        payment_type_code: "pagofacil",
        merchant_payment_code: "86a75049eb0",
        currency_code: "ARS",
        amount_total: "100.00"
    }
})

A successful request will return a JSON expression similar to the one below. You will need to redirect the customer to voucher_url.

Copy

{
  "redirect_url": null,
  "payment": {
    "hash": "59db71b5b65a5ed4edd2e94e3ef0cf35013ff14c36ee310b",
    "pin": "849289789",
    "merchant_payment_code": "8374f94f71a",
    "order_number": null,
    "status": "PE",
    "status_date": null,
    "open_date": "2017-10-09 12:55:16",
    "confirm_date": null,
    "transfer_date": null,
    "amount_br": "376.00",
    "amount_ext": "100.00",
    "amount_iof": "0.00",
    "currency_rate": "3.7600",
    "currency_ext": "USD",
    "due_date": "2017-10-12",
    "instalments": "1",
    "payment_type_code": "pagofacil",
    "voucher_url": "https://sandbox.ebanxpay.com/print/voucher/execute?hash=59db71b5b65a5ed4edd2e94e3ef0cf35013ff14c36ee310b",
    "pre_approved": false,
    "capture_available": null
  },
  "status": "SUCCESS"
}

Cupon de Pagos – Direct API

The following parameters are specific to the Cupon de Pagos payment method:

payment.payment_type_code string

The value must be cupon for Cupon de Pagos payments.

curl Node.js PHP Ruby

Copy

curl -X POST 'https://sandbox.ebanxpay.com/ws/direct' \
    -d 'request_body={
    "integration_key": "your_test_integration_key_here",
    "operation": "request",
    "payment": {
    "name": "Random Name",
    "email": "random@example.com",
    "document": "23876543214",
    "address": "Boulevard Jorde",
    "street_number": "555",
    "city": "Moreno",
    "state": "BA",
    "zipcode": "15796",
    "phone_number": "0405777687",
    "country": "ar",
    "payment_type_code": "cupon",
    "merchant_payment_code": "0564b3c5ae0",
    "currency_code": "ARS",
    "amount_total": "100"
    }
}'

Copy

var module = require('ebanx');
var ebanx = new module();

ebanx.configure({
    integrationKey : "your_test_integration_key_here",
    testMode: true
});

var params = {
    payment : {
        name : "Random Name",
        email : "random@example.com",
        document: "23876543214",
        address :"Boulevard Jorde",
        street_number : "555",
        city : "Moreno",
        state : "BA",
        zipcode : "15796",
        phone_number : "0405777687",
        country : "ar",
        payment_type_code : "cupon",
        merchant_payment_code : "26cca8a952b",
        currency_code : "ARS",
        amount_total : "100.00"
    }
};

ebanx.direct(params, function(err, reply) {
    if (err) {
        console.log(err);
    } else {
        console.log(reply);
    }
});

Copy

require 'vendor/autoload.php';

\Ebanx\Config::set([
    'integrationKey' => 'your_test_integration_key_here'
    , 'directMode' => true
    , 'testMode' => true
]);

\Ebanx\Ebanx::doRequest([
    'mode' => 'full'
    , 'operation' => 'request'
    , 'payment' => [
        'name' => 'Random Name'
        , 'email' => 'random@example.com'
        , 'document' => '23876543214',
        , 'address' => 'Boulevard Jorde'
        , 'street_number' => '555'
        , 'city' => 'Moreno'
        , 'state' => 'BA'
        , 'zipcode' => '15796'
        , 'phone_number' => '0405777687'
        , 'country' => 'ar'
        , 'payment_type_code' => 'cupon'
        , 'merchant_payment_code' => 'dde592395b5'
        , 'currency_code' => 'ARS'
        , 'amount_total' => 100
    ]
]);

Copy

require 'ebanx'

Ebanx.tap do |e|
    e.integration_key = 'your_test_integration_key_here'
    e.test_mode = true
end

response = Ebanx.do_direct({
    payment: {
        name: "Random Name",
        email: "random@example.com",
        document: "23876543214",
        address:"Boulevard Jorde",
        street_number: "555",
        city: "Moreno",
        state: "BA",
        zipcode: "15796",
        phone_number: "0405777687",
        country: "ar",
        payment_type_code: "cupon",
        merchant_payment_code: "86a75049eb0",
        currency_code: "ARS",
        amount_total: "100.00"
    }
})

A successful request will return a JSON expression similar to the one below. You will need to redirect the customer to voucher_url.

Copy

{
  "redirect_url": null,
  "payment": {
    "hash": "59db728043d942616d32a90b333a4e1689da3300d3afd2af",
    "pin": "440604540",
    "merchant_payment_code": "312dbfb9432",
    "order_number": null,
    "status": "PE",
    "status_date": null,
    "open_date": "2017-10-09 12:58:40",
    "confirm_date": null,
    "transfer_date": null,
    "amount_br": "376.00",
    "amount_ext": "100.00",
    "amount_iof": "0.00",
    "currency_rate": "3.7600",
    "currency_ext": "USD",
    "due_date": "2017-10-12",
    "instalments": "1",
    "payment_type_code": "cupon",
    "voucher_url": "https://sandbox.ebanxpay.com/print/voucher/execute?hash=59db728043d942616d32a90b333a4e1689da3300d3afd2af",
    "pre_approved": false,
    "capture_available": null
  },
  "status": "SUCCESS"
}

Credit card – Direct API

The following parameters are specific for the credit card payment method:

payment.payment_type_code string

The value of this field always will be creditcard for credit card transactions.

payment.instalments integer

The number of instalments of the payment (from 1 to 12 expect 7 and 8).

payment.creditcard JSON

An object containing the customer’s credit card information.

payment.creditcard.card_number string

Credit card number.

payment.creditcard.card_name string

Credit card cardholder name.

payment.creditcard.card_due_date string

Credit card due date (“valid thru”) in the format mm/yyyy.

payment.creditcard.card_cvv string

Credit card security code.

payment.creditcard.auto_capture boolean

If true, the payment will be captured automatically by EBANX; if false, the payment will have to be captured by the merchant using the API method capture.

curl Node.js PHP Ruby

Copy

curl -X POST 'https://sandbox.ebanxpay.com/ws/direct' \
    -d 'request_body={
    "integration_key": "your_test_integration_key_here",
    "operation": "request",
        "payment": {
        "name": "José Silva",
        "email": "joseargentina@example.com",
        "document": "30-52135353-1",
        "address": "Rua teste",
        "street_number": "1040",
        "city": "Boulevard Joure",
        "state": "Buenos Aires,
        "zipcode": "61919",
        "country": "ar",
        "phone_number": "8522847035",
        "payment_type_code": "creditcard",
        "merchant_payment_code": "9asdhad1f4096a2",
        "currency_code": "USD",
        "amount_total": 100,
        "creditcard": {
            "card_number": "4111111111111111",
            "card_name": "José Silva",
            "card_due_date": "12/2019",
            "card_cvv": "123"
        }
    }
}'

Copy

var module = require('ebanx');
var ebanx = new module();

ebanx.configure({
    integrationKey : "your_test_integration_key_here",
    testMode: true
});

var params = {
    payment : {
        name : "José Silva",
        email : "joseargentina@example.com",
        document : "30-52135353-1",
        address :"Rua E",
        street_number : "1040",
        city : "Boulevard Joure",
        state : "Buenos Aires",
        zipcode : "61919",
        country : "ar",
        phone_number : "8522847035",
        payment_type_code : "creditcard",
        merchant_payment_code : "600ebe848ed",
        currency_code : "USD",
        amount_total : "100.00",
        creditcard : {
            card_number : 4111111111111111,
            card_name : "José Silva",
            card_due_date : "12/2019",
            card_cvv : "123"
        }
    }
};

ebanx.direct(params, function(err, reply) {
    if (err) {
        console.log(err);
    } else {
        console.log(reply);
    }
});

Copy

require 'vendor/autoload.php';

\Ebanx\Config::set([
    'integrationKey' => 'your_test_integration_key_here'
    , 'directMode' => true
    , 'testMode' => true
]);

\Ebanx\Ebanx::doRequest([
    'mode' => 'full'
    , 'operation' => 'request'
    , 'payment' => [
        'name' => 'José Silva'
        , 'email' => 'joseargentina@example.com'
        , 'document' => '30-52135353-1'
        , 'address' => 'Rua E'
        , 'street_number' => '1040'
        , 'city' => 'Boulevard Joure'
        , 'state' => 'Buenos Aires'
        , 'zipcode' => '61919'
        , 'country' => 'br'
        , 'phone_number' => '8522847035'
        , 'payment_type_code' => 'creditcard'
        , 'merchant_payment_code' => '6ca1fd80a27'
        , 'currency_code' => 'USD'
        , 'amount_total' => 100.00
        , 'creditcard' => [
            'card_number' => '4111111111111111'
            , 'card_name' => 'José Silva'
            , 'card_due_date' => '12/2019'
            , 'card_cvv' => '123'
        ]
    ]
]);

Copy

require 'ebanx'

Ebanx.tap do |e|
    e.integration_key = 'your_test_integration_key_here'
    e.test_mode = true
end

response = Ebanx.do_direct({
    payment: {
        name: "José Silva",
        email: "joseargentina@example.com",
        document: "853.513.468-93",
        address:"Rua E",
        street_number: "1040",
        city: "Boulevard Joure",
        state: "Buenos Aires",
        zipcode: "61919",
        country: "ar",
        phone_number: "8522847035",
        payment_type_code: "creditcard",
        merchant_payment_code: "0a0e4f3824d",
        currency_code: "USD",
        amount_total: "100.00",
        creditcard: {
            card_number: "4111111111111111",
            card_name: "José Silva",
            card_due_date: "12/2019",
            card_cvv: "123"
        }
    }
})

A successful request will return a JSON expression similar to the one below. Credit card payments for merchants with fraud checking enable will have status PE (pending), while for merchants that have fraud checking disabled and auto_capture set to true it will have status CO (confirmed).

Copy

{
  "payment": {
    "hash": "59acc5f00945fa382ab051651440826da7701533249b3a475",
    "pin": "045868576",
    "country" : "ar"
    "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": "376.00",
    "amount_ext": "100.00",
    "amount_iof": "0.00",
    "currency_rate": "3.7600",
    "currency_ext": "USD",
    "due_date": "2017-09-07",
    "instalments": "3",
    "payment_type_code": "visa",
    "details": {
      "billing_descriptor": "TP * EBANX S.A."
    },
    "transaction_status": {
      "acquirer": "EBANX",
      "code": "OK",
      "description": "Sandbox - Test credit card, transaction captured"
    },
    "pre_approved": true,
    "capture_available": false
  },
  "status": "SUCCESS"
}

This page's content:

Payment Page API

Direct API

RapiPago – Direct API

PagoFacil – Direct API

Cupon de Pagos – Direct API

Credit card – Direct API

First Steps

Integration Methods

Sandbox Testing