react-native-yoco
Version:
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.
37 lines • 1.56 kB
TypeScript
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 declare function initialise(): void;
/**
* Configures Yoco SDK
* @param params Configuration parameters
* @returns {void}
* @throws {Error}
*/
export declare function configure(params: ConfigureParams): void;
/**
* Get device type
* @returns {string}
*/
export declare function getDeviceType(): string;
/**
* Pairs Yoco terminal
* @returns {ResultCodes}
* @throws {Error} with ResultCodes as message
*/
export declare function pairTerminal(): Promise<ResultCodes>;
/**
* Making a payment
* @param params
* @returns {Promise<ChargeResult>}
*/
export declare function charge(params: ChargeParams): Promise<PaymentResult>;
export declare function getPaymentResult(params: GetPaymentResultParams): Promise<PaymentResult>;
export declare function refund(params: RefundParams): Promise<RefundResult | undefined>;
export declare function queryTransactions(params: QueryTransactionsParams): Promise<QueryTransactionsResult>;
export { ChangeEventPayload, ConfigureParams, PaymentType, SupportedCurrency, ChargeParams, PaymentResult, ResultCodes, QueryTransactionsParams, QueryTransactionsResult, RefundParams, RefundResult, };
//# sourceMappingURL=index.d.ts.map