Inicialización

Integración de OrkestaPay

Inicializar instancia de OrkestaPay

Primero se agrega el CDN del script de OrkestaPay

Importante: Agregar el script dentro de las etiquetas body, ya que si se agregan dentro de las etiquetas head va a enviar errores en consola y no se va a inicializar correctamente.

<script type="text/javascript" src="https://checkout.orkestapay.com/script/orkestapay.js"></script>

Posteriormente, se va a necesitar el merchant_id y el public_key, que se pueden obtener desde el portal en el apartado de Desarrolladores.

Para inicializar la instancia del script de OrkestaPay, ejecuta la siguiente función:

const merchant_id = '{YOUR_MERCHANT_ID}';
const public_key = '{YOUR_PUBLIC_KEY_OR_DEVICE_KEY}';
const orkestapay = initOrkestaPay({ merchant_id, public_key });

Para configurar el modo Sandbox, se le pasa la propiedad opcional is_sandbox:

const is_sandbox = true;
const merchant_id = '{YOUR_MERCHANT_ID}';
const public_key = '{YOUR_PUBLIC_KEY_OR_DEVICE_KEY}';
const orkestapay = initOrkestaPay({ is_sandbox, merchant_id, public_key });

Importante: Inicializar una sola vez el script de OrkestaPay.

Obtener las promociones disponibles

Para obtener el listado de promociones disponibles, se ejecuta el método getPromotions y necesita un objeto como parámetro con las siguientes propiedades:

bin_number (Requerido): Los primeros 6 dígitos del número de tarjeta.
currency (Requerido): El código de la moneda.
total_amount (Requerido): El monto total a pagar.

(async function getPromotions() {
    const bin_number = '424242';
    const currency = 'MXN';
    const total_amount = '100.00';
    const promotions = await orkestapay.getPromotions({
        bin_number,
        currency,
        total_amount,
    });
})();

Obtener la información del dispositivo

Para obtener la información del dispositivo, se ejecuta el método getDeviceInfo, éste no necesita parámetros:

(async function getDeviceInfo() {
  const { device_session_id } = await orkestapay.getDeviceInfo();
})();

Modelos y entidades

Función initOrkestaPay

function initOrkestaPay(orkestaPayParams: OrkestaPayParams): OrkestaPay;

Clase OrkestaPay

class OrkestaPay {
  public createCard(mount_card_params?: MountCardParams): Promise<OrkestaPayCard>;
  public getPromotions(params: PromotionsParams): Promise<CardPromotion[]>;
  public getDeviceInfo(): Promise<DeviceInfo>;
}

Clase OrkestaPayParams

class OrkestaPayParams {
  public merchant_id!: string;
  public public_key!: string;
  public is_sandbox?: boolean;
}

Clase PromotionsParams

class PromotionsParams {
  public bin_number!: string;
  public currency!: string;
  public total_amount!: number | string;
}

Clase CardPromotion

class CardPromotion {
  public type!: string;
  public installments!: number[];
}

Clase DeviceInfo

class DeviceInfo {
  public device_session_id!: string;
  public fingerprint!: string;
}