Onepay

API y SDKs Backend

Ambientes y Credenciales

Onepay.setIntegrationType(Onepay.IntegrationType.LIVE);

OnepayBase::setCurrentIntegrationType('LIVE');

Onepay.IntegrationType = Transbank.Onepay.Enums.OnepayIntegrationType.LIVE;

Transbank::Onepay::Base.integration_type = :LIVE

onepay.integration_type = onepay.IntegrationType.LIVE

Host: www.onepay.cl

• LIVE (Producción) corresponde al sistema productivo con transacciones reales. La URL Base es https://www.onepay.cl

Onepay.setIntegrationType(Onepay.IntegrationType.TEST);

OnepayBase::setCurrentIntegrationType('TEST');

Onepay.IntegrationType = Transbank.Onepay.Enums.OnepayIntegrationType.TEST;

Transbank::Onepay::Base.integration_type = :TEST

onepay.integration_type = onepay.IntegrationType.TEST

Host: onepay.ionix.cl

• TEST (Integración) se utiliza para el desarrollo y la validación de una integración. La URL Base es https://onepay.ionix.cl.

En cuanto a credenciales, todos los métodos del API requieren tres parámetros:

Los SDKs manejan automáticamente el parámetro appKey.

• appKey: Identifica el lenguaje de programación usado.

Onepay.setApiKey("api-key-entregado-por-transbank");
Onepay.setSharedSecret("secreto-entregado-por-transbank");

OnepayBase::setApiKey("api-key-entregado-por-transbank");
OnepayBase::setSharedSecret("secreto-entregado-por-transbank");

Onepay.ApiKey = "api-key-entregado-por-transbank";
Onepay.SharedSecret = "secreto-entregado-por-transbank";

Transbank::Onepay::Base.api_key = "entregado por transbank"
Transbank::Onepay::Base.shared_secret = "entregado por transbank"

onepay.api_key = "api-key-entregado-por-transbank"
onepay.shared_secret = "secreto-entregado-por-transbank"

• apiKey: Identificador del comercio, entregado por Transbank.

Los SDKs manejan automáticamente el cálculo del parámetro signature

• signature: Corresponde a la representación base64 de un hash HMAC-SHA256 usando como llave un shared secret entregado por Transbank al comercio. El texto a firmar con esa llave es la concatenación ciertos parámetros de negocio (documentados en cada endpoint) precedidos el largo de cada string.

  Por ejemplo, si el valor de los parámetros a concatenar fuera "foobar", "baz" y "quux" entonces el string a firmar sería "6foobar3baz4quux".

Los SDKs por defecto se conectan al ambiente TEST usando estas credenciales de prueba.

Simulador de Transacciones

Dentro del flujo de venta, puedes utilizar un simulador de transacciones donde podrás generar casos de éxito y fracaso, para utilizarlo sigue los siguientes pasos:

• Una vez presionado el botón para iniciar la compra, se mostrará la ventana de pago Onepay, tal como se ve en la imagen. Toma nota del número que aparece como "Código de compra", ya que lo necesitarás para emular el pago en el siguiente paso.

• En otra ventana del navegador, ingresa al emulador de pagos desde https://onepay.ionix.cl/mobile-payment-emulator/, utiliza test@onepay.cl como correo electrónico, y el código de compra obtenido desde la pantalla anterior. Una vez ingresado los datos solicitados, presiona el botón "Iniciar Pago":

• Si todo va bien, el emulador mostrará opciones para simular situaciones distintas. Para simular un pago exitoso, presiona el botón PRE_AUTHORIZED. En caso de querer simular un pago fallido, presiona le botón REJECTED. Simularemos un pago exitoso presionando el botón PRE_AUTHORIZED.

• Vuelve a la ventana del navegador donde comenzaste, y podrás comprobar que el pago ha sido exitoso.

• Alternativamente, en vez de simular un pago exitoso puedes simular un pago rechazado utilizando el botón REJECTED en el emulador. Si vuelves a la ventana del comercio, podrás ver que la operación ha sido cancelada.

Códigos de Error Comunes

Todos los endpoints pueden entregar como respuesta los siguientes responseCode:

• "INVALID_PLUGIN_VERSION"(la appKey no se encuentra registrada en la base de datos).
• "INVALID_APP_KEY" (la appKey no está activa).
• "COMMERCE_NOT_FOUND" (apiKey no corresponde a ningún comercio registrado).
• "SIGN_VALIDATION_ERROR" (falla la validación de la firma por motivos de encriptación, no por su contenido).
• "INVALID_TRANSACTION_SIGN" (falla la validación del contenido de la firma).

Además, cada endpoint puede tener condiciones adicionales de error que serán representadas por otros valores de responseCode.

Crear una Transacción

Crea una transacción a partir de un carro de compras.

POST /ewallet-plugin-api-services/services/transactionservice/sendtransaction

Onepay.setAppScheme("mi-app://mi-app/onepay-result");
Onepay.setCallbackUrl("https://miapp.cl/endPayment");
Onepay.setQrWidthHeight(100); // Opcional
Onepay.setCommerceLogoUrl("https://some.url/logo"); // Opcional

ShoppingCart cart = new ShoppingCart();
cart.add(
    new Item()
        .setDescription("Producto de prueba")
        .setQuantity(1)
        .setAmount(9900)
        .setAdditionalData(null)
        .setExpire(-1));
TransactionCreateResponse response = Transaction.create(
  cart, Onepay.Channel.WEB);

// O, si lo deseas, puedes configurar opciones por transacción
TransactionCreateResponse response = Transaction.create(
  cart, Onepay.Channel.WEB,
  new Options().setQrWidthHeight(200)
               .setCommerceLogoUrl("https://commerce.cl/logo")
)

OnepayBase::setAppScheme("mi-app://mi-app/onepay-result");
OnepayBase::setCallbackUrl("https://miapp.cl/endPayment");
OnepayBase::setQrWidthHeight(100); // Opcional
OnepayBase::setCommerceLogoUrl("https://some.url/logo"); // Opcional

$cart = new ShoppingCart();
$cart->add(
  new Item('Producto de prueba', 1, 9900, null, null));
$response = Transaction::create($cart, $channel, 'WEB');

// O, si lo deseas, puedes configurar opciones por transacción
$options = new options()
$options->setQrWidthHeight(200);
$options->setCommerceLogoUrl("https://commerce.cl/logo");
$response = Transaction::create($cart, $channel, 'WEB', $options);

Onepay.AppScheme = "mi-app://mi-app/onepay-result";
Onepay.CallbackUrl = "https://miapp.cl/endPayment";
Onepay.QrWidthHeight = 100; // Opcional
Onepay.CommerceLogoUrl = "https://some.url/logo"; // Opcional

ShoppingCart cart = new ShoppingCart();
cart.Add(new Item(
    description: "Producto de prueba",
    quantity: 1,
    amount: 9900,
    additionalData: null,
    expire: -1));
var response = Transaction.Create(cart, ChannelType.Web);

// O, si lo deseas, puedes configurar opciones por transacción
var response = Transaction.Create(cart, ChannelType.Web, new Options(
  commerceLogoUrl: 'https://some.url/logo',
  qrWidthHeight: 200
));

Transbank::Onepay::Base.app_scheme = "mi-app://mi-app/onepay-result"
Transbank::Onepay::Base.callback_url = "https://miapp.cl/endPayment"
Transbank::Onepay::Base.qr_width_height = 100 # Opcional
Transbank::Onepay::Base.commerce_logo_url = "https://some.url/logo" # Opcional


cart = Transbank::Onepay::ShoppingCart.new
cart.add(Transbank::Onepay::Item.new(amount: 9000,
                  quantity: 1,
                  description: "Producto de prueba",
                  additional_data: nil,
                  expire: -1))
channel = Transbank::Onepay::Channel::WEB
response = Transbank::Onepay::Transaction.create(shopping_cart: cart, channel: channel)

# O, si lo deseas, puedes configurar opciones por transacción
response = Transbank::Onepay::Transaction.create(
  shopping_cart: cart, channel: channel, options: {
    qr_width_height: 200, commerce_logo_url: 'https://commerce.cl/logo'
  }
)

onepay.app_scheme = "mi-app://mi-app/onepay-result"
onepay.callback_url = "https://miapp.cl/endPayment"
onepay.qr_width_height = 100 # Opcional
onepay.commerce_logo_url = "https://some.url/logo" # Opcional

cart = ShoppingCart()
cart.add(Item(description="Producto de prueba",
              quantity=1, amount=9900,
              additional_data=None, expire=None))
result = Transaction.create(cart, Channel.WEB)

# O, si lo deseas, puedes configurar opciones por transacción
result = Transaction.create(cart, Channel.WEB, Options(commerce_logo_url="https://commerce.cl/logo", qr_width_height=200))

POST /ewallet-plugin-api-services/services/transactionservice/sendtransaction
Content-Type: application/json

{
  "appKey": "04533c31-fe7e-43ed-bbc4-1c8ab1538afp",
  "apiKey": "Y12GCTN6PEB24N$C8S9QSSJT#1#GVXRF",
  "externalUniqueNumber": 1470696668,
  "signature": "YOKQ+vIZnkzbzmGxw8geEhzIQFv2RyVoUdJZF1qaWYg=",
  "total": "9900",
  "itemsQuantity": 1,
  "issuedAt": 1470696658,
  "items": [
    {
      "description": "Producto de prueba",
      "quantity": "1",
      "amount": "9900",
      "additionalData": null,
      "expire": null
    }
  ],
  "callbackUrl": "https://miapp.cl/endPayment",
  "channel": "WEB",
  "appScheme": "mi-app://mi-app/onepay-result",
  "generateOttQrCode": "false",
  "widthHeight": 200,
  "commerceLogoUrl":"https://www.ionix.cl/img/logo_ionix.png"
}

Parámetros Crear una Transacción

Respuesta Crear una Transacción

response.getOcc();
response.getOtt();
response.getExternalUniqueNumber();
response.getIssuedAt();
response.getQrCodeAsBase64();

response->getOcc();
response->getOtt();
response->getExternalUniqueNumber();
response->getIssuedAt();
response->getQrCodeAsBase64();

response.Occ;
resppnse.Ott;
response.ExternalUniqueNumber;
response.IssuedAt;
response.QrCodeAsBase64;

response.occ
response.ott
response.external_unique_number
response.issued_at
response.qr_code_as_base64

response.occ
response.ott
response.external_unique_number
response.issued_at
response.qr_code_as_base64

200 OK
Content-Type: application/json

{
  "responseCode": "OK",
  "description": "OK",
  "result": {
    "occ": "1608630732695575",
    "ott": 12345678,
    "signature": "fnFy6sFPW0NHFXIagH9xyt2iQe3wf5PaXr8oSgI3/h0=",
    "externalUniqueNumber": "1470696668",
    "issuedAt": 1470696663,
    "qrCodeAsBase64": "jkdjiojijiuh768ygYTBUHGYGYYTRF788989878y876777fgfgfgfghretgyguyo8njhjhugyug6766668yuui"
  }
}

Los SDKs sólo retornan los campos presentes dentro de result. Si el responseCode es diferente de "OK" lanzan una excepción incluyendo el responseCode y description.

Callbacks

Cuando la transacción sea aprobada o rechazada, se invocará vía método GET la URL callbackUrl (en canal WEB modalidad checkout y en canal MOBILE) o la URL appScheme (en canal APP) con los siguientes parámetros.

Los parámetros son todos String (pues son parte de una URL), excepto en Android donde los parámetros de un intent son tipados. Ver la referencia del SDK móvil para más detalles.

Especificar tus propios external unique numbers

TransactionCreateResponse response = Transaction.create(
  cart, Onepay.Channel.WEB, myOwnExternalUniqueNumber);

$response = Transaction::create(
  $cart, $channel, 'WEB', myOwnExternalUniqueNumber);

var response = Transaction.Create(
  cart, ChannelType.Web, myOwnExternalUniqueNumber);

response = Transbank::Onepay::Transaction.create(shopping_cart: cart,
                                                 channel: channel,
                                                 external_unique_number: my_external_unique_number)

response = Transaction.create(shopping_cart, Channel.WEB,
  my_own_external_unique_number)

Al usar los SDKs si no provees un external unique number, será generado automáticamente. Pero siempre puedes especificarlo manualmente.

Confirmar una Transacción

A través del servicio gettransactionnumber se obtiene la información de una transacción y al mismo tiempo se confirma por parte del comercio.

POST /ewallet-plugin-api-services/services/transactionservice/gettransactionnumber

TransactionCommitResponse response =
  Transaction.commit(occ, externalUniqueNumber);

$response = Transaction::commit($occ, $externalUniqueNumber);

var response = Transaction.Commit(occ, externalUniqueNumber);

response = Transbank::Onepay::Transaction.commit(occ: occ,
                                                 external_unique_number: external_unique_number)

response = Transaction.commit(occ, external_unique_number)

POST /ewallet-plugin-api-services/services/transactionservice/gettransactionnumber
Content-Type: application/json

{
  "appKey": "04533c31-fe7e-43ed-bbc4-1c8ab1538afp",
  "apiKey": "Y12GCTN6PEB24N$C8S9QSSJT#1#GVXRF",
  "occ": "1608630732695575",
  "externalUniqueNumber": "1470696668",
  "issuedAt": 1470696704,
  "signature": "Pomj0wYjR0WahF1Xwe1xmVGWd4VvU3n4oMzwSkn4/44="
}

Parámetros Confirmar una Transacción

Respuesta Confirmar una Transacción

response.getOcc();
response.getAuthorizationCode();
response.getIssuedAt();
response.getAmount();
response.getTransactionDesc();
response.getInstallmentsAmount();
response.getInstallmentsNumber();
response.getBuyOrder();

response->getOcc();
response->getAuthorizationCode();
response->getIssuedAt();
response->getAmount();
response->getTransactionDesc();
response->getInstallmentsAmount();
response->getInstallmentsNumber();
response->getBuyOrder();

response.Occ;
response.AuthorizationCode;
response.IssuedAt;
response.Amount;
response.TransactionDesc;
response.InstallmentsAmount;
response.InstallmentsNumber;
response.BuyOrder;

response.occ
response.authorization_code
response.issued_at
response.amount
response.transaction_desc
response.installments_amount
response.installments_number
response.buy_order

response.occ
response.authorization_code
response.issued_at
response.amount
response.transaction_desc
response.installments_amount
response.installments_number
response.buy_order

200 OK
Content-Type: application/json

{
  "responseCode": "OK",
  "description": "OK",
  "result": {
    "occ": "1608630732695575",
    "authorizationCode": "768136",
    "issuedAt": 1470696663,
    "signature": "q1K/7JSIVcfq/PN5ruwTnfLRbUaYROX+3P3h4uCw1x4=",
    "amount": 9900,
    "transactionDesc": "Venta normal sin cuotas",
    "installmentsAmount": 9900,
    "installmentsNumber": 1,
    "buyOrder": "123456",
  }
}

Los SDKs sólo retornan los campos presentes dentro de result. Si el responseCode es diferente de "OK" lanzan una excepción incluyendo el responseCode y description.

Anular una Transacción

A través del servicio nullifyTransaction se puede anular una transacción previamente autorizada y confirmada.

POST /ewallet-plugin-api-services/services/transactionservice/gettransactionnumber anulación

RefundCreateResponse response =
  Refund.create(amount, occ, externalUniqueNumber,
  authorizationCode);

$response = Refund::create(
  $amount, $occ, $externalUniqueNumber,$authorizationCode);

var response = Refund.Create(
  amount, occ, externalUniqueNumber, authorizationCode);

response = Transbank::Onepay::Refund.create(nullify_amount: amount,
                                            occ: occ,
                                            external_unique_number: external_unique_number,
                                            authorization_code: authorization_code)

response = Refund.create(amount, occ, external_unique_number,
  authorization_code)

POST /ewallet-plugin-api-services/services/transactionservice/gettransactionnumber
Content-Type: application/json

{
  "appKey": "04533c31-fe7e-43ed-bbc4-1c8ab1538afp",
  "apiKey": "Y12GCTN6PEB24N$C8S9QSSJT#1#GVXRF",
  "occ": "1608630732695575",
  "externalUniqueNumber": "1470696668",
  "authorizationCode": "768136",
  "nullifyAmount": 9900,
  "issuedAt": 1470696708,
  "signature": "NEKbDrujSy7D3fj4k/2JxEurQCVWSqQLWDm43n+C/uA="
}

Respuesta Anular una Transacción

response.getOcc();
response.getExternalUniqueNumber();
response.getReverseCode();
response.getIssuedAt();

response->getOcc();
response->getExternalUniqueNumber();
response->getReverseCode();
response->getIssuedAt();

response.Occ;
response.ExternalUniqueNumber;
response.ReverseCode;
response.IssuedAt;

response.occ
response.external_unique_number
response.reverse_code
response.issued_at

response.occ
response.external_unique_number
response.reverse_code
response.issued_at

200 OK
Content-Type: application/json

{
  "responseCode": "OK",
  "description": "OK",
  "result": {
    "occ": "1608630732695575",
    "externalUniqueNumber": "1470696668",
    "reverseCode": "768136",
    "issuedAt": 1470696708,
    "signature": "Y09ESVxkx/xcAUt+FhVnvMMVvHE7ZTFEkZr1LDt0TAo="
  }
}

Los SDKs sólo retornan los campos presentes dentro de result. Si el responseCode es diferente de "OK" lanzan una excepción incluyendo el responseCode y description.

SDK Frontend JavaScript

Modalidad Checkout

La modalidad checkout del SDK JavaScript permite integrar fácilmente Onepay, simplemente invocando a una función JavaScript e implementando dos endpoints en tu backend. Onepay checkout se encarga de levantar un "modal" que toma el control de toda la experiencia del usuario y la sincronización con la app Onepay.

Onepay.checkout(options)

Realiza una integración simple de Onepay a través de un modal que mantiene informado al usuario en todo momento de los siguientes pasos a seguir para completar su pago con Onepay. Si el usuario está en un dispositivo móvil esta integración transparentemente usa la app nativa de Onepay en lugar del modal.

Es la integración recomendada, por su facilidad de integración y su versatilidad.

Parámetros Checkout

Ejemplo:

Onepay.checkout({
 endpoint: './transaction-create',
 commerceLogo: 'https://tu-url.com/images/logo-01.png',
 callbackUrl: './onepay-result',
 transactionDescription: 'Set de pelotas'
});

Respuesta Checkout

Ninguna.

Parámetros endpoint

El endpoint de creación de transacción será invocado via POST y recibirá los siguientes parámetros:

Respuesta endpoint

Se espera que el endpoint responda a checkout con el siguiente resultado como una respuesta JSON:

Ejemplo de respuesta:

{
"externalUniqueNumber":"38bab443-c55b-4d4e-86fa-8b9f4a2d2d13",
"amount":88000,
"qrCodeAsBase64":"QRBASE64STRING",
"issuedAt":1534216134,
"occ":"1808534370011282",
"ott":89435749
}

Parámetros callbackUrl

El callback final será invocado via GET y recibirá los siguientes parámetros:

Los parámetros son todos String (pues son parte de una URL).

Respuesta callbackUrl

El callback NO debe entregar JSON como resultado, pues tiene el control del navegador del usuario. Por lo tanto el callback debe entregar una página web (sea de éxito o fracaso) con la información pertinente.

Modalidad QR Directo

En la modalidad QR Directo tienes todas las herramientas a tu disposición para controlar tú mismo la experiencia del usuario, la sincronización con la app Onepay y la comunicación con tu backend. Por lo tanto, lo que se ofrecen son un set de funciones que te brindan dichas herramientas.

Onepay.getChannel()

Entrega el canal apropiado para iniciar una transacción Onepay en el backend. Es tú responsabilidad llevar este valor hacia tu backend para crear la transacción con el canal entregado.

Parámetros QR Directo

Ninguno.

Respuesta QR Directo

Un String con valor "WEB" (si el usuario está en un navegador desktop) o "MOBILE" (si se encuentra en un navegador de smartphone).

Onepay.isMobile()

Indica si el usuario está usando un smartphone para navegar la página actual. Una vez que hayas creado la transacción (o en el momento que prefieras) te permite saber si el usuario está en un smartphone (y por tanto no tiene sentido dibujar un QR)

Parámetros Onepay.isMobile()

Ninguno.

Respuesta Onepay.isMobile()

Un Boolean con valor true si el usuario está usando un smartphone y false en caso contrario.

Onepay.redirectToApp(occ)

Ejemplo:

if (Onepay.isMobile()) {
 Onepay.redirectToApp(transaction.occ);
 return;
}

Lleva al usuario a la app nativa de Onepay par autorizar una transacción. La interfaz que le indique al usuario que puede abrir dicha app (y/o lo invite a instalar Onepay) es tu responsabilidad.

Parámetros redirectToApp(occ)

Respuesta redirectToApp(occ)

Ninguna. Al final del flujo de aprobación del pago recibirás el callback que hayas configurado al invocar el API de creación de transacción (o que hayas configurado en tu SDK de backend).

Onepay.directQr(transaction, htmlTagId)

Dibuja el código QR y te permite escuchar los eventos de Onepay para sincronizarte con lo que ocurra en la app del usuario.

Parámetros Onepay.directQr

Ejemplo:

var transaction = {
   occ:1808696602719171,
   ott:60361166,
   externalUniqueNumber:"cf734d22-550c-449b-aa68-a57d64831b41",
   qrCodeAsBase64:"iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAADkklEQVR42u3dQW7CQB>BE0bn/peEEWUSy6aqe96XsEDJ4HouO" +
    "7TkfSX92fAUSIBIgEiASIBIgEiASIBIgEiCSAJEAkQCRAJEAkQCRAJEAkQCRAJEEiASIBIgEiHQLkHNO>xd9/j7/l9bedL0AAAQQQQAABBBBAAA" +
    "EEEEAAAQSQZ7/wsdHdQ8fTsjDSADatH0AAAQQQQAABBBBAAAEEEEAAAQSQ8/rCazmeKchbzxcggAACCC>CAAAIIIIAAAggggAACCCC/PJ609wEE" +
    "EEAAAQQQQAABBBBAAAEEEEAAAaQRyFPfw9axMCCAAAIIIIAAAggggAACCCCAAALIbiDtx9MCwfkCBBDn>CxBAAAEEEEAAAQQQQAABBJA3xoC2P5" +
    "h9ve0PAAEEEEAseEAAAQQQQAABBBBAANkN5LbaN/EUIIAIEEAECCCAAAIIIIAAAsidQG7b1LJlvJm2mW>niDwIggAACCCCAAAIIIIAAAggggAAC" +
    "SN6D19LGvGlAbhwvAwIIIIAAAggggAACCCCAAAIIIIDMAWm5pbRlQbYfPyCAAAIIIIAAAggggAACCCCA>AALIb+Ckvf/UwmgZd7tYERBAAAEEEE" +
    "AAAQQQQAABBBBAANkBZOs496kF0PK9bRgLAwIIIIAAAggggAACCCCAAAIIIIDMwdk69mx5EFwTHEAAAQ>QQQAABBBBAAAEEEEAAAQSQ/m0Ftm7W" +
    "mTam9n8QQAABBBBAAAEEEEAAAQQQQAABxPYHyT8ILXDaPxcggAACCCCAAAIIIIAAAggggAACSObCa7kF>Ne34Wz4vIIAAAggggAACCCCAAAIIII" +
    "AAAsidtW8rkLbNBCCAAAIIIIAAIkAAESCAAAIIIJlA0rYhaLm4rn2MPPV5AQEEEEAAAQQQQAABBBBAAA>EEEEB2j0lbFnbamHTzrbiAAAIIIIAA" +
    "AggggAACCCCAAAIIID23uN4GLW2cPhkggAACCCCAAAIIIIAAAggggAACSP>+D2raOr9sfTAcIIIAAAggggAACCCCAAAIIIIAAAkjCiUsbL7dcVA" +
    "kIIIAAAggggAACCCCAAAIIIIAAMntCt44xty7IposYAQEEEEAAAQQQQAABBBBAAAEEEED2LqSWzTTfPo>9TY3xAAAEEEEAAAQQQQAABBBBAAAEE" +
    "EOmuAJEAkQCRAJEAkQCRAJEAkQCRAJEEiASIBIgEiASIBIgEiASIBIgEiCRAJEAkQCRApIS>+jaaPZv11nXQAAAAASUVORK5CYII\u003d",

   paymentStatusHandler: {
       ottAssigned: function () {
           // callback transacción asignada
           console.log("Transacción asignada.");

       },
       authorized: function (occ, externalUniqueNumber) {
           // callback transacción autorizada
           console.log("occ: " + occ);
           console.log("externalUniqueNumber: " +
             externalUniqueNumber);

           // funcion no incluida en sdk
           sendRedirect("./transaction-commit",
             occ, externalUniqueNumber);
       },
       canceled: function () {
           // callback rejected by user
           console.log("Transacción cancelada por el usuario.");

       },
       authorizationError: function () {
           // cacllback authorization error
           console.log("Error de autorizacion.");

       },
       unknown: function () {
           // callback to any unknown status recived
           console.log("Estado desconocido.");

       }
   }
};
var htmlTagId = 'qr-image';
Onepay.directQr(transaction, htmlTagId);

Callbacks Onepay.directQr

Los siguientes elementos dentro de transaction.paymentStatusHandler serán llamados cuando ocurran los eventos correspondientes:

SDK para Apps Móviles

Los SDK para apps móviles permiten integrar directo en tu app. Sin navegadores webs ni webviews, tus usuarios tendrán la mejor experiencia de pago app-to-app.

Todas las funciones de los SDK Móviles son métodos de una instancia onepay.

En iOS:

let onepay = OnePay()

En Android:

OnePay onepay = new OnePay(this);

Detectar e instalar la app Onepay

En Android debes pasar un contexto como parámetro al constructor de OnePay (típicamente el activity actual desde el que usas Onepay)

En iOS:

if (onepay.isOnePayInstalled()) {
     // Todo OK, sigue adelante
} else {
    // Ofrece al usuario si quiere instalar Onepay.
    // En caso que esté de acuerdo, usa lo siguiente para iniciar la instalación:
    onepay.installOnePay()
}

En Android:

if (onepay.isOnePayInstalled()) {
  // Todo OK, sigue adelante
} else {
  // Ofrece al usuario si quiere instalar Onepay.
  // En caso que esté de acuerdo, usa lo siguiente para
  // iniciar la instalación:
  onepay.installOnePay();
}

isOnePayInstalled()

Este método te permite saber si la app Onepay ya se encuentra instalada en el dispositivo del usuario.

Parámetros isOnePayInstalled

Ninguno.

Respuesta isOnePayInstalled

Retorna true si la app Onepay está instalada, false en caso contrario.

installOnePay()

Si has detectado que Onepay no está presente puedes invitar al usuario a probar Onepay y luego con este método gatillas la instalación de Onepay en el dispositivo del usuario.

Parámetros installOnePay

Ninguno.

Respuesta installOnePay

Ninguna.

Iniciar una transacción app-to-app

El uso principal del SDK móvil es invocar a la app de Onepay para completar una transacción ya iniciada en tu backend.

initPayment(occ, callback)

En iOS:

onepay.initPayment(occ,
    callback: {(statusCode, description) in
        switch statusCode {
        case OnePayState.occInvalid:
            // Algo anda mal con el occ que obtuviste
            // desde el backend.
            // Debes reintentar obtener el occ o abortar
            os_log("OCC inválida")
        case OnePayState.notInstalled:
            // Onepay no está instalado.
            // Debes abortar o pedir al usuario instalar
            // Onepay (y luego reintentar initPayment)
            os_log("Onepay no instalado")
        }
    }
)

En Android:

onepay.initPayment(occ, new OnePayCallback() {
    @Override
    public void failure(Error error, String s) {
        switch (error) {
            case INVALID_OCC:
                // Algo anda mal con el occ que obtuviste
                // desde el backend.
                // Debes reintentar obtener el occ o abortar
                break;
            case ONE_PAY_NOT_INSTALLED:
                // Onepay no está instalado.
                // Debes abortar o pedir al usuario
                // instalar Onepay (y luego reintentar
                // initPayment)
                break;
            default:
                Log.e(TAG, "Error inesperado al iniciar pago Onepay " +
                    error.toString> () + ":" + s);
                // Aborta o reintenta
        }
    }
});

Si Onepay está instalado y creaste en tu backend una transacción para el canal APP, sólo necesitas la occ para iniciar el pago:

Parámetros initPayment

Respuesta initPayment

Ninguna. En caso de error será invocado el callback y en caso de que el control pase exitosamente a Onepay retomarás el control mediante el appScheme que hayas enviado en el API cuando creaste la transacción (o el que hayas configurado en tu SDK).

callback

El callback de ser invocado recibirá dos parámetros:

Retomar el control en tu app iOS

En iOS la URL que hayas indicado en appSchema (al crear la transacción con el API i en la configuración de tu SDK backend) será invocada por Onepay para retomar el control. Debes manejar esta URL en tu AppDelegate. Los parámetros que te permitirán saber el resultado de la transacción los recibirás en la query string de esta URL:

Los parámetros son todos String (pues son parte de una URL),

Si quieres saber más sobre cómo manejar la invocación a tu appScheme, consulta la guía de Onepay en la sección de integración para app móvil.

Finalmente deberás enviar a tu backend la información que recibiste para que confirme la transacción usando el API o uno de nuestros SDK backend.

Retomar el control en tu app Android

En Android se invocará tu appSchema mediante un Intent que debes configurar para que esté asociado a la misma URL de tu appSchema e invoque a un Activity de tu app.

Cuando Onepay realice la invocación podrás leer los parámetros via getIntent().getStringExtra() (para Strings, el método cambia para otros tipos de datos, por ejemplo getIntent().getLongExtra() para campos de tipo Long como issuedAt).

Si quieres saber más sobre cómo configurar tu Activity para que reciba la invocación de Onepay, consulta la guía de Onepay en la sección de integración para app móvil.

Finalmente deberás enviar a tu backend la información que recibiste para que confirme la transacción usando el API o uno de nuestros SDK backend.

Dibujar QR para implementar modalidad Cortafilas en Android

Para la modalidad Cortafilas, hemos dispuesto en el SDK Android un componente que dibujará el QR a partir de la ott.

Para integrar este componente, debes agregar en el archivo build.gradle del módulo que contiene tu proyecto Android (generalmente en app/build.gradle).

En el archivo build.gradle:

dependencies {
  implementation 'com.google.zxing:core:3.3.0'
  implementation('com.journeyapps:zxing-android-embedded:3.6.0') { transitive = false }
}

También debes agregar el componente en tu archivo layout.

En el archivo xml del layout:

<cl.ionix.tbk_ewallet_sdk_android.ui.QROnepayView
                android:id="@+id/qr_imageView"
                android:layout_width="150dp"
                android:layout_height="150dp" />

Y en la clase Java del Activity o Fragment en donde estás agregando el componente, debes obtener el elemento del layout para setear el ott.

En la clase encargada del layout:

QROnepayView imageViewQrCode = inflatedView.findViewById(R.id.qr_imageView);
imageViewQrCode.setOtt(ott);

Dibujar QR para implementar modalidad Cortafilas en iOS

Para integrar este componente, puedes hacerlo por una de las dos formas:

• Programáticamente. Dentro la inicialización de tu UIViewController, debes inicializar la clase QROnepayView y agregarlo a tu vista.

Para incorporarlo programáticamente:

let qrOnepayView = QROnepayView(ott: "12345678")
qrOnepayView.frame = CGRect(x: 0, y: 0, width: 200, height: 200)
self.view.addSubview(qrOnepayView)

• Usando Storyboards. En el UIViewController, agrega un View para indicar como Custom Class la clase QROnepayView. En el código de la implementación del UIViewController, sobre la variable que posee el Outlet de la clase, debes setear el ott.

Al usar Storyboard:

qrOnepayView.setOtt("12345678")