node-wipay
Version:
This is a node wrapper for the WiPay Caribbean V1 API.
36 lines • 1.08 kB
TypeScript
import WiPayAuth from '../auth';
export declare type WiPayVoucherResponse = {
status: string;
msg: string;
transactionId?: string;
value?: number;
};
/**
* something
* @param {WiPayAuth} auth
* @return {WiPayVoucher}
*/
declare class WiPayVoucher {
private _authorisation;
/**
* WiPayVoucher Constructor
* @param {WiPayAuth} authorisation
*/
constructor(authorisation: WiPayAuth);
/**
* Makes a call to the Voucher API to check the value of a voucher.
* @param {string} voucher
* @return {Promise<WiPayVoucherResponse>}
*/
check: (voucher: string) => Promise<WiPayVoucherResponse>;
/**
* Makes a Payment call to the Voucher API.
* @param {string} voucher
* @param {number} total
* @param {string} details
* @return {Promise<WiPayVoucherResponse>}
*/
pay: (voucher: string, total: number, details?: "This is a voucher payment." | undefined) => Promise<WiPayVoucherResponse>;
}
export default WiPayVoucher;
//# sourceMappingURL=index.d.ts.map