@vantagepay/vantagepay 0.15.0 → 0.15.2

package/dist/payments/types.d.ts

@@ -26,9 +26,9 @@ export declare abstract class AccountHolderTransactionResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -116,9 +116,9 @@ export declare class CardVerificationPaymentRequest {
 /** Contains the details of the bank account you would like to pay money into. */
 export declare class BankAccountDestination {
     /**
-    * A token that can be used instead of a bank account number.
-    *             If a token is present a bank account does not need to be provided.
-    */
+     * A token that can be used instead of a bank account number.
+     *             If a token is present a bank account does not need to be provided.
+     */
     token?: string;
     /** The bank account number of the recipient. */
     accountNumber: string;
@@ -137,11 +137,11 @@ export declare class BankAccountDestination {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -178,9 +178,9 @@ export declare class BankAccountDestinationResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -222,11 +222,11 @@ export declare class BillDestination {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -262,9 +262,9 @@ export declare class BillDestinationResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -288,9 +288,9 @@ export declare class BillDestinationResult {
 /** Model to hold details of a card into which a payment should be made. */
 export declare class CardDestination {
     /**
-    * A token that can be used instead of a card number.
-    *             If a token is present a card does not need to be provided.
-    */
+     * A token that can be used instead of a card number.
+     *             If a token is present a card does not need to be provided.
+     */
     token?: string;
     /** The full card number. */
     cardNumber: string;
@@ -307,11 +307,11 @@ export declare class CardDestination {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -345,9 +345,9 @@ export declare class CardDestinationResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -381,11 +381,11 @@ export declare class CashDestination {
     /** A 3 character ISO currency code. */
     currency: Currency;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -415,9 +415,9 @@ export declare class CashDestinationResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -450,11 +450,11 @@ export declare class GenericDestination {
     /** A 3 character ISO currency code. */
     currency: Currency;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -491,11 +491,11 @@ export declare class MerchantDestination {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -531,9 +531,9 @@ export declare class MerchantDestinationResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -557,9 +557,9 @@ export declare class MerchantDestinationResult {
 /** Contains the details of the mobile money account you would like to make a payment into. */
 export declare class MobileWalletDestination {
     /**
-    * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
-    *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
-    */
+     * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
+     *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
+     */
     msisdn: string;
     /** The mobile wallet operator that owns the mobile money account. */
     mobileWalletOperator: MobileWalletOperator;
@@ -576,11 +576,11 @@ export declare class MobileWalletDestination {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -614,9 +614,9 @@ export declare class MobileWalletDestinationResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -689,11 +689,11 @@ export declare class QrCodeDestination {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -729,9 +729,9 @@ export declare class QrCodeDestinationResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -773,11 +773,11 @@ export declare class WalletDestination {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -810,9 +810,9 @@ export declare class WalletDestinationResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -836,9 +836,9 @@ export declare class WalletDestinationResult {
 export declare enum FeeType {
     None = "None",
     /**
-    * A real-time commission that is deducted from the amount we are instructed to debit from a source account so that the amount we actually
-    *             debit is less the commission to be paid to the account holder being debited and the commission is therefore effectively paid in real-time.
-    */
+     * A real-time commission that is deducted from the amount we are instructed to debit from a source account so that the amount we actually
+     *             debit is less the commission to be paid to the account holder being debited and the commission is therefore effectively paid in real-time.
+     */
     FeeTakenFromSourceByMerchant = "FeeTakenFromSourceByMerchant",
     Elevy = "Elevy",
     /** A processing fee charged by the external payment processor that we used to process the payment, that is charged to us, and is not charged to the end user. */
@@ -899,20 +899,20 @@ export declare class PaymentReceiptResponse {
     /** The transaction batch description/reference that can appear in notifications and statements. */
     description?: string;
     /**
-    * A globally unique payment reference (UUID) that was generated when the initial payment request was submitted.
-    *             <para>
-    *             This reference is returned in the response to that initial payment request.
-    *             </para>
-    */
+     * A globally unique payment reference (UUID) that was generated when the initial payment request was submitted.
+     *             <para>
+     *             This reference is returned in the response to that initial payment request.
+     *             </para>
+     */
     paymentReference: string;
     /** A short unique payment reference based on the payment ID. */
     shortPaymentReference: string;
     /**
-    * An optional reference that is associated with every transaction batch that participates in a split payment.
-    *             This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
-    *             The client processing the split payment is responsible for generating this reference and ensuring that
-    *             all transaction batches that are part of the split payment are associated with the same split reference.
-    */
+     * An optional reference that is associated with every transaction batch that participates in a split payment.
+     *             This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
+     *             The client processing the split payment is responsible for generating this reference and ensuring that
+     *             all transaction batches that are part of the split payment are associated with the same split reference.
+     */
     splitReference?: string;
     /** A verification code that can be used to validate that an external payment was triggered by a trusted device (used for offline payments for example). */
     verificationCode: string;
@@ -965,20 +965,20 @@ export declare class PaymentStatusResponse {
     /** The transaction batch description/reference that can appear in notifications and statements. */
     description?: string;
     /**
-    * A globally unique payment reference (UUID) that was generated when the initial payment request was submitted.
-    *             <para>
-    *             This reference is returned in the response to that initial payment request.
-    *             </para>
-    */
+     * A globally unique payment reference (UUID) that was generated when the initial payment request was submitted.
+     *             <para>
+     *             This reference is returned in the response to that initial payment request.
+     *             </para>
+     */
     paymentReference: string;
     /** A short unique payment reference based on the payment ID. */
     shortPaymentReference: string;
     /**
-    * An optional reference that is associated with every transaction batch that participates in a split payment.
-    *             This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
-    *             The client processing the split payment is responsible for generating this reference and ensuring that
-    *             all transaction batches that are part of the split payment are associated with the same split reference.
-    */
+     * An optional reference that is associated with every transaction batch that participates in a split payment.
+     *             This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
+     *             The client processing the split payment is responsible for generating this reference and ensuring that
+     *             all transaction batches that are part of the split payment are associated with the same split reference.
+     */
     splitReference?: string;
     /** A verification code that can be used to validate that an external payment was triggered by a trusted device (used for offline payments for example). */
     verificationCode: string;
@@ -1008,11 +1008,11 @@ export declare class PaymentTransaction {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1042,9 +1042,9 @@ export declare abstract class PaymentTransactionResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1103,9 +1103,9 @@ export declare class RefundReceiptResponse {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1139,17 +1139,17 @@ export declare class RefundRequest {
         [key: string]: string;
     };
     /**
-    * The amount to refund.
-    *             <para>This value cannot be larger than the amount that was originally sourced by the transaction referenced by <see cref="P:ZGA.Core.Models.Payments.RefundRequest.SourceTransactionReference" />.</para>
-    */
+     * The amount to refund.
+     *             <para>This value cannot be larger than the amount that was originally sourced by the transaction referenced by <see cref="P:ZGA.Core.Models.Payments.RefundRequest.SourceTransactionReference" />.</para>
+     */
     refundAmountInCents: number;
 }
 /** A model to hold the details of a response to a refund request. */
 export declare class RefundResponse {
     /**
-    * A globally unique refund transaction reference (UUID) generated by the system internally to identify a specific refund transaction.
-    *             <para>Can be used to check the status of a refund.</para>
-    */
+     * A globally unique refund transaction reference (UUID) generated by the system internally to identify a specific refund transaction.
+     *             <para>Can be used to check the status of a refund.</para>
+     */
     reference: string;
     /** A set of URLs that can be used to check the status of a refund either via polling or SignalR. */
     refundStatusUrls: StatusUrls;
@@ -1172,9 +1172,9 @@ export declare class RefundStatusResponse {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1216,9 +1216,9 @@ export declare class RefundTransactionResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1256,11 +1256,11 @@ export declare class ApplePaySource {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1276,9 +1276,9 @@ export declare class ApplePaySource {
 }
 export declare class BankAccountSource {
     /**
-    * A token that can be used instead of a bank account number.
-    *             If a token is present a bank account does not need to be provided.
-    */
+     * A token that can be used instead of a bank account number.
+     *             If a token is present a bank account does not need to be provided.
+     */
     token?: string;
     /** The bank account number from which funds will be withdrawn. */
     accountNumber: string;
@@ -1295,11 +1295,11 @@ export declare class BankAccountSource {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1333,9 +1333,9 @@ export declare class BankAccountSourceResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1359,9 +1359,9 @@ export declare class BankAccountSourceResult {
 /** Model to hold the details of a card from which a payment should be made. */
 export declare class CardSource {
     /**
-    * A token that can be used instead of a card number.
-    *             If a token is present a card does not need to be provided.
-    */
+     * A token that can be used instead of a card number.
+     *             If a token is present a card does not need to be provided.
+     */
     token?: string;
     /** The name of the card company that issued this card: VISA, MasterCard, AMEX etc. */
     cardIssuer: CardIssuer;
@@ -1369,9 +1369,9 @@ export declare class CardSource {
     /** The full card number. */
     cardNumber: string;
     /**
-    * The Card Verification Value found on the back of the card.
-    *             This is either 3 or 4 digits long.
-    */
+     * The Card Verification Value found on the back of the card.
+     *             This is either 3 or 4 digits long.
+     */
     cvv?: string;
     /** The name of the card holder as printed on the card. */
     nameOnCard: string;
@@ -1395,11 +1395,11 @@ export declare class CardSource {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1433,9 +1433,9 @@ export declare class CardSourceResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1467,11 +1467,11 @@ export declare class CashSource {
     /** A 3 character ISO currency code. */
     currency: Currency;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1501,9 +1501,9 @@ export declare class CashSourceResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1534,11 +1534,11 @@ export declare class GenericSource {
     /** A 3 character ISO currency code. */
     currency: Currency;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1565,11 +1565,11 @@ export declare class GooglePaySource {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1588,19 +1588,19 @@ export declare class MobileWalletSource {
     /** The mobile wallet operator that owns the mobile money account. */
     mobileWalletOperator: MobileWalletOperator;
     /**
-    * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
-    *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
-    */
+     * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
+     *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
+     */
     msisdn: string;
     /**
-    * A voucher code issued by your network provider (currently Vodafone/Telecel or GMoney) in order to verify your payment.
-    *             This can also actually be a One Time Pin code, despite being referred to as a VoucherCode, that is generated by the MNO but needs to be submitted via the payment engine.
-    */
+     * A voucher code issued by your network provider (currently Vodafone/Telecel or GMoney) in order to verify your payment.
+     *             This can also actually be a One Time Pin code, despite being referred to as a VoucherCode, that is generated by the MNO but needs to be submitted via the payment engine.
+     */
     voucherCode?: string;
     /**
-    * A PIN issued to the subscriber.
-    *             This is usually a static PIN code and is currently only applicable for Zeepay.
-    */
+     * A PIN issued to the subscriber.
+     *             This is usually a static PIN code and is currently only applicable for Zeepay.
+     */
     subscriberPin?: string;
     /** The transaction description/reference that can appear in notifications and statements. */
     description?: string;
@@ -1613,11 +1613,11 @@ export declare class MobileWalletSource {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1651,9 +1651,9 @@ export declare class MobileWalletSourceResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1715,11 +1715,11 @@ export declare class WalletSource {
     /** Set this optional flag to avoid actually processing a transaction. */
     doNotProcess: boolean;
     /**
-    * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
-    *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
-    *             This flag can only be used with server integrations and will be ignored for any other calls.
-    *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
-    */
+     * Set this optional flag to avoid confirmation steps for the transaction such as confirming additional fees or target account verification.
+     *             The details of the payment will be stored but the transaction will not pause to request confirmation of the destination from the client.
+     *             This flag can only be used with server integrations and will be ignored for any other calls.
+     *             This flag is optional and if it is omitted from the payment request it will default to FALSE and confirmation will be requested.
+     */
     disableConfirmation: boolean;
     /** A collection of public data that can be associated with the transaction. */
     clientData: {
@@ -1751,9 +1751,9 @@ export declare class WalletSourceResult {
     /** The amount that the payment engine attempted to process, in cents, inclusive of fees and exclusive of real time commissions. */
     amountAttemptedInCents: number;
     /**
-    * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
-    *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
-    */
+     * The amount that the payment engine actually processed, in cents, inclusive of fees and exclusive of real time commissions.
+     *             This amount, as stored in the database, is already adjusted for Fees and Commissions, so we do not need to adjust it here.
+     */
     amountInCents: number;
     /** The cashback amount, in cents. */
     cashbackAmountInCents: number;
@@ -1904,16 +1904,16 @@ export declare class MerchantPaymentRequest {
     /** Specify the channel that this payment originated from. */
     channel: Channel;
     /**
-    * A unique client reference for this payment.
-    *             This is optional to detect duplicate calls and also allow you to associate payments with your own internal reference numbers.
-    */
+     * A unique client reference for this payment.
+     *             This is optional to detect duplicate calls and also allow you to associate payments with your own internal reference numbers.
+     */
     yourReference?: string;
     /**
-    * An optional reference that is associated with every transaction batch that participates in a split payment.
-    *             This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
-    *             The client processing the split payment is responsible for generating this reference and ensuring that
-    *             all transaction batches that are part of the split payment are associated with the same split reference.
-    */
+     * An optional reference that is associated with every transaction batch that participates in a split payment.
+     *             This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
+     *             The client processing the split payment is responsible for generating this reference and ensuring that
+     *             all transaction batches that are part of the split payment are associated with the same split reference.
+     */
     splitReference?: string;
     /** Optional consumer information of the person making the payment. */
     consumer?: BasicConsumer;
@@ -1926,19 +1926,19 @@ export declare class MerchantPaymentRequest {
     /** A text description of the payment. Sometimes also referred to as a Narration. */
     description?: string;
     /**
-    * A schedule definition to use to schedule payments to recur in the future.
-    *             If a schedule is supplied it must include either an end date or a repeat count and it must specify what repeat interval to use.
-    */
+     * A schedule definition to use to schedule payments to recur in the future.
+     *             If a schedule is supplied it must include either an end date or a repeat count and it must specify what repeat interval to use.
+     */
     recurrenceSchedule?: PaymentRecurrenceSchedule;
     /**
-    * When a payment request instance is spawned by a recurrence schedule this property will be populated so that it is possible to lookup the specific schedule entry in the database
-    *             that is associated with payment request instance in question.
-    */
+     * When a payment request instance is spawned by a recurrence schedule this property will be populated so that it is possible to lookup the specific schedule entry in the database
+     *             that is associated with payment request instance in question.
+     */
     scheduledSequenceNumber?: number;
     /**
-    * In certain scenarios a confirmation may be requested from the client before transaction processing starts (confirming fees for example).
-    *             Use this flag to indicate that you want to automatically confirm any initial confirmations.
-    */
+     * In certain scenarios a confirmation may be requested from the client before transaction processing starts (confirming fees for example).
+     *             Use this flag to indicate that you want to automatically confirm any initial confirmations.
+     */
     disableInitialConfirmation: boolean;
     /** A list of line items associated with this payment. */
     lineItems: LineItem[];
@@ -1954,16 +1954,16 @@ export declare class PaymentRequest {
     /** Specify the channel that this payment originated from. */
     channel: Channel;
     /**
-    * A unique client reference for this payment.
-    *             This is optional to detect duplicate calls and also allow you to associate payments with your own internal reference numbers.
-    */
+     * A unique client reference for this payment.
+     *             This is optional to detect duplicate calls and also allow you to associate payments with your own internal reference numbers.
+     */
     yourReference?: string;
     /**
-    * An optional reference that is associated with every transaction batch that participates in a split payment.
-    *             This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
-    *             The client processing the split payment is responsible for generating this reference and ensuring that
-    *             all transaction batches that are part of the split payment are associated with the same split reference.
-    */
+     * An optional reference that is associated with every transaction batch that participates in a split payment.
+     *             This is used for split payments in environments like restaurants where multiple transaction batches contribute to one common bill.
+     *             The client processing the split payment is responsible for generating this reference and ensuring that
+     *             all transaction batches that are part of the split payment are associated with the same split reference.
+     */
     splitReference?: string;
     /** Optional consumer information of the person making the payment. */
     consumer?: BasicConsumer;
@@ -1976,19 +1976,19 @@ export declare class PaymentRequest {
     /** A text description of the payment. Sometimes also referred to as a Narration. */
     description?: string;
     /**
-    * A schedule definition to use to schedule payments to recur in the future.
-    *             If a schedule is supplied it must include either an end date or a repeat count and it must specify what repeat interval to use.
-    */
+     * A schedule definition to use to schedule payments to recur in the future.
+     *             If a schedule is supplied it must include either an end date or a repeat count and it must specify what repeat interval to use.
+     */
     recurrenceSchedule?: PaymentRecurrenceSchedule;
     /**
-    * When a payment request instance is spawned by a recurrence schedule this property will be populated so that it is possible to lookup the specific schedule entry in the database
-    *             that is associated with payment request instance in question.
-    */
+     * When a payment request instance is spawned by a recurrence schedule this property will be populated so that it is possible to lookup the specific schedule entry in the database
+     *             that is associated with payment request instance in question.
+     */
     scheduledSequenceNumber?: number;
     /**
-    * In certain scenarios a confirmation may be requested from the client before transaction processing starts (confirming fees for example).
-    *             Use this flag to indicate that you want to automatically confirm any initial confirmations.
-    */
+     * In certain scenarios a confirmation may be requested from the client before transaction processing starts (confirming fees for example).
+     *             Use this flag to indicate that you want to automatically confirm any initial confirmations.
+     */
     disableInitialConfirmation: boolean;
     /** A list of line items associated with this payment. */
     lineItems: LineItem[];