react-native-yoco/src/index.ts

The Yoco SDK allows app developers to integrate with Yoco card machines to accept in-person payments from within their application. The most common scenario is to accept Yoco payments from within your Point of Sale application.

// Import the native module. On web, it will be resolved to ReactNativeYoco.web.ts
// and on native platforms to ReactNativeYoco.ts
import ReactNativeYocoModule from "./ReactNativeYocoModule";
import {
  ChangeEventPayload,
  ChargeParams,
  ConfigureParams,
  PaymentResult as PaymentResult,
  GetPaymentResultParams,
  QueryTransactionsParams,
  QueryTransactionsResult,
  RefundParams,
  RefundResult,
} from "./ReactNativeYoco.types";
import {
  PaymentType,
  ResultCodes,
  SupportedCurrency,
} from "./ReactNativeYocoEnums";

/**
 * Initialises Yoco SDK
 * @returns {void}
 * @throws {Error}
 */
export function initialise(): void {
  return ReactNativeYocoModule.initialise();
}

/**
 * Configures Yoco SDK
 * @param params Configuration parameters
 * @returns {void}
 * @throws {Error}
 */
export function configure(params: ConfigureParams) {
  return ReactNativeYocoModule.configure(params.secret);
}

/**
 * Get device type
 * @returns {string}
 */
export function getDeviceType() {
  return ReactNativeYocoModule.getDeviceType();
}

/**
 * Pairs Yoco terminal
 * @returns {ResultCodes}
 * @throws {Error} with ResultCodes as message
 */
export async function pairTerminal() {
  return await ReactNativeYocoModule.pairTerminal();
}

/**
 * Making a payment
 * @param params
 * @returns {Promise<ChargeResult>}
 */
export async function charge(params: ChargeParams): Promise<PaymentResult> {
  return await ReactNativeYocoModule.charge(
    params.amountInCents,
    params.paymentType,
    params.currency,
    params.tipInCents,
    params.paymentParameters
  );
}

export async function getPaymentResult(
  params: GetPaymentResultParams
): Promise<PaymentResult> {
  return await ReactNativeYocoModule.getPaymentResult(
    params.transactionId,
    params.showResult || false
  );
}

export async function refund(
  params: RefundParams
): Promise<RefundResult | undefined> {
  return await ReactNativeYocoModule.refund(
    params.transactionId,
    params.amountInCents,
    params?.userInfo,
    params?.staffMember
  );
}

export async function queryTransactions(
  params: QueryTransactionsParams
): Promise<QueryTransactionsResult> {
  return await ReactNativeYocoModule.queryTransactions(params.receiptNumber);
}

export {
  ChangeEventPayload,
  ConfigureParams,
  PaymentType,
  SupportedCurrency,
  ChargeParams,
  PaymentResult,
  ResultCodes,
  QueryTransactionsParams,
  QueryTransactionsResult,
  RefundParams,
  RefundResult,
};