From f68f658f284d0349fe630f6c2b776a9ba73f5720 Mon Sep 17 00:00:00 2001 From: Tpay CI Date: Fri, 23 Jan 2026 10:02:13 +0000 Subject: [PATCH] Update docs --- docs/assets/icons.js | 2 +- docs/assets/icons.svg | 2 +- docs/classes/Address.html | 4 +- docs/classes/AmbiguousAlias.html | 8 +- docs/classes/AmbiguousBlikPayment.html | 4 +- docs/classes/AmountPaymentConstraint.html | 10 +- docs/classes/ApplePayConfiguration.html | 4 +- docs/classes/ApplePayPayment.html | 4 +- docs/classes/AutomaticPaymentMethods.html | 4 +- docs/classes/BlikAlias.html | 4 +- docs/classes/BlikPayment.html | 4 +- docs/classes/Callbacks.html | 4 +- .../CertificatePinningConfiguration.html | 4 +- docs/classes/ConfigurationSuccess.html | 10 +- docs/classes/CreditCard.html | 4 +- docs/classes/CreditCardConfig.html | 4 +- docs/classes/CreditCardPayment.html | 4 +- docs/classes/ExpirationDate.html | 4 +- docs/classes/GooglePayConfiguration.html | 4 +- docs/classes/GooglePayConfigureError.html | 8 +- docs/classes/GooglePayConfigureResult.html | 6 +- docs/classes/GooglePayConfigureSuccess.html | 6 +- docs/classes/GooglePayOpenCancelled.html | 12 +- docs/classes/GooglePayOpenNotConfigured.html | 12 +- docs/classes/GooglePayOpenResult.html | 12 +- docs/classes/GooglePayOpenSuccess.html | 14 +- docs/classes/GooglePayOpenUnknownError.html | 12 +- docs/classes/GooglePayPayment.html | 4 +- docs/classes/GooglePayUtilsConfiguration.html | 4 +- docs/classes/Languages.html | 4 +- docs/classes/LocalizedString.html | 4 +- docs/classes/Merchant.html | 4 +- docs/classes/MerchantAuthorization.html | 4 +- docs/classes/MerchantDetails.html | 4 +- docs/classes/MethodCallError.html | 12 +- docs/classes/ModuleClosed.html | 10 +- docs/classes/Notifications.html | 4 +- docs/classes/PayPoPayment.html | 4 +- docs/classes/Payer.html | 4 +- docs/classes/PayerContext.html | 4 +- docs/classes/PaymentCancelled.html | 12 +- docs/classes/PaymentChannel.html | 12 +- docs/classes/PaymentChannelsError.html | 10 +- docs/classes/PaymentChannelsResult.html | 8 +- docs/classes/PaymentChannelsSuccess.html | 10 +- docs/classes/PaymentCompleted.html | 12 +- docs/classes/PaymentConstraint.html | 6 +- docs/classes/PaymentCreated.html | 12 +- docs/classes/PaymentDetails.html | 4 +- docs/classes/PaymentGroup.html | 10 +- docs/classes/PaymentMethods.html | 4 +- docs/classes/RatyPekaoPayment.html | 4 +- docs/classes/Recursive.html | 4 +- docs/classes/Redirects.html | 4 +- docs/classes/Result.html | 10 +- .../classes/ScreenlessBlikAmbiguousAlias.html | 16 +-- .../ScreenlessConfiguredPaymentFailed.html | 16 +-- docs/classes/ScreenlessMethodCallError.html | 16 +-- docs/classes/ScreenlessPaid.html | 16 +-- docs/classes/ScreenlessPayment.html | 4 +- docs/classes/ScreenlessPaymentCreated.html | 16 +-- docs/classes/ScreenlessPaymentError.html | 16 +-- docs/classes/ScreenlessResult.html | 14 +- docs/classes/ScreenlessValidationError.html | 16 +-- docs/classes/SingleTransaction.html | 4 +- docs/classes/TokenPayment.html | 4 +- docs/classes/Tokenization.html | 4 +- docs/classes/TokenizationCompleted.html | 10 +- docs/classes/TokenizationFailure.html | 10 +- docs/classes/TokenizedCard.html | 4 +- docs/classes/TpayConfiguration.html | 4 +- docs/classes/Transaction.html | 4 +- docs/classes/TransferPayment.html | 4 +- docs/classes/ValidationError.html | 12 +- docs/classes/WalletConfiguration.html | 4 +- docs/enums/CreditCardBrand.html | 4 +- docs/enums/DigitalWallet.html | 4 +- docs/enums/Frequency.html | 4 +- docs/enums/GooglePayEnvironment.html | 4 +- docs/enums/InstallmentPayment.html | 4 +- docs/enums/Language.html | 4 +- docs/enums/PaymentConstraintType.html | 4 +- docs/enums/PaymentMethod.html | 4 +- docs/enums/TpayEnvironment.html | 4 +- docs/functions/TpayButton.html | 2 +- docs/functions/configure.html | 2 +- docs/functions/configureGooglePayUtils.html | 2 +- .../getAvailablePaymentChannels.html | 2 +- docs/functions/isGooglePayAvailable.html | 2 +- docs/functions/openGooglePay.html | 2 +- .../screenlessAmbiguousBLIKPayment.html | 2 +- docs/functions/screenlessApplePayPayment.html | 2 +- docs/functions/screenlessBLIKPayment.html | 2 +- .../screenlessCreditCardPayment.html | 2 +- .../functions/screenlessGooglePayPayment.html | 2 +- docs/functions/screenlessPayPoPayment.html | 2 +- .../functions/screenlessRatyPekaoPayment.html | 2 +- docs/functions/screenlessTransferPayment.html | 2 +- docs/functions/startCardTokenPayment.html | 2 +- docs/functions/startPayment.html | 2 +- docs/functions/tokenizeCard.html | 2 +- docs/index.html | 129 ++++++++++++------ docs/types/TpayButtonProps.html | 6 +- 103 files changed, 400 insertions(+), 357 deletions(-) diff --git a/docs/assets/icons.js b/docs/assets/icons.js index 58882d7..3ae8f55 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -3,7 +3,7 @@ function addIcons() { if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; svg.style.display = "none"; if (location.protocol === "file:") updateUseElements(); } diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index 50ad579..10db10b 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ -MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/classes/Address.html b/docs/classes/Address.html index d0b3b37..5a89c6b 100644 --- a/docs/classes/Address.html +++ b/docs/classes/Address.html @@ -1,5 +1,5 @@ Address | react-native-tpay
react-native-tpay
    Preparing search index...

    Class Address

    Class responsible for storing payer address

    -
    Index

    Constructors

    Index

    Constructors

    Properties

    address city countryCode @@ -8,4 +8,4 @@
  • city: string | null

    city name

  • countryCode: string | null

    country code, for example 'PL'

  • postalCode: string | null

    postal code

    -
  • Returns Address

    Properties

    address: string | null
    city: string | null
    countryCode: string | null
    postalCode: string | null
    +

    Returns Address

    Properties

    address: string | null
    city: string | null
    countryCode: string | null
    postalCode: string | null
    diff --git a/docs/classes/AmbiguousAlias.html b/docs/classes/AmbiguousAlias.html index 164638d..c1fae7e 100644 --- a/docs/classes/AmbiguousAlias.html +++ b/docs/classes/AmbiguousAlias.html @@ -1,7 +1,7 @@ AmbiguousAlias | react-native-tpay
    react-native-tpay
      Preparing search index...

      Class AmbiguousAlias

      Class responsible for storing ambiguous alias information

      -
      Index

      Constructors

      Index

      Constructors

      Properties

      Constructors

      Properties

      code: string

      Alias identifier

      -
      name: string

      Alias display name

      -
      +

      Constructors

      Properties

      code: string

      Alias identifier

      +
      name: string

      Alias display name

      +
      diff --git a/docs/classes/AmbiguousBlikPayment.html b/docs/classes/AmbiguousBlikPayment.html index 37b55e0..5423887 100644 --- a/docs/classes/AmbiguousBlikPayment.html +++ b/docs/classes/AmbiguousBlikPayment.html @@ -1,9 +1,9 @@ AmbiguousBlikPayment | react-native-tpay
      react-native-tpay
        Preparing search index...

        Class AmbiguousBlikPayment

        Class responsible for storing information about ambiguous BLIK payment

        -
        Index

        Constructors

        Index

        Constructors

        Properties

        ambiguousAlias: AmbiguousAlias
        blikAlias: BlikAlias
        transactionId: string
        +

        Returns AmbiguousBlikPayment

        Properties

        ambiguousAlias: AmbiguousAlias
        blikAlias: BlikAlias
        transactionId: string
        diff --git a/docs/classes/AmountPaymentConstraint.html b/docs/classes/AmountPaymentConstraint.html index cfd6b11..d654cca 100644 --- a/docs/classes/AmountPaymentConstraint.html +++ b/docs/classes/AmountPaymentConstraint.html @@ -1,9 +1,9 @@ AmountPaymentConstraint | react-native-tpay
        react-native-tpay
          Preparing search index...

          Class AmountPaymentConstraint

          Class responsible for storing information about amount payment constraint

          -

          Hierarchy (View Summary)

          Index

          Constructors

          Hierarchy (View Summary)

          Index

          Constructors

          Properties

          Constructors

          Properties

          maximum: number | null | undefined

          maximum price that can be used while creating the transaction

          -
          minimum: number | null | undefined

          minimum price that can be used while creating the transaction

          -
          type: amount

          type of a payment constraint

          -
          +

          Constructors

          Properties

          maximum: number | null | undefined

          maximum price that can be used while creating the transaction

          +
          minimum: number | null | undefined

          minimum price that can be used while creating the transaction

          +
          type: amount

          type of a payment constraint

          +
          diff --git a/docs/classes/ApplePayConfiguration.html b/docs/classes/ApplePayConfiguration.html index 0ef0607..6d51697 100644 --- a/docs/classes/ApplePayConfiguration.html +++ b/docs/classes/ApplePayConfiguration.html @@ -1,7 +1,7 @@ ApplePayConfiguration | react-native-tpay
          react-native-tpay
            Preparing search index...

            Class ApplePayConfiguration

            Class responsible for storing information about Apple Pay configuration.

            -
            Index

            Constructors

            Index

            Constructors

            Properties

            countryCode: string
            merchantIdentifier: string
            +

            Returns ApplePayConfiguration

            Properties

            countryCode: string
            merchantIdentifier: string
            diff --git a/docs/classes/ApplePayPayment.html b/docs/classes/ApplePayPayment.html index 6e845cc..68e0ac8 100644 --- a/docs/classes/ApplePayPayment.html +++ b/docs/classes/ApplePayPayment.html @@ -1,8 +1,8 @@ ApplePayPayment | react-native-tpay
            react-native-tpay
              Preparing search index...

              Class ApplePayPayment

              Class responsible for storing information about Apple Pay payment

              -

              Hierarchy (View Summary)

              Index

              Constructors

              Hierarchy (View Summary)

              Index

              Constructors

              Properties

              applePayToken: string
              callbacks: Callbacks
              payer: Payer
              paymentDetails: PaymentDetails
              +
            • paymentDetails: PaymentDetails
            • payer: Payer
            • callbacks: Callbacks
            • Returns ApplePayPayment

              Properties

              applePayToken: string
              callbacks: Callbacks
              payer: Payer
              paymentDetails: PaymentDetails
              diff --git a/docs/classes/AutomaticPaymentMethods.html b/docs/classes/AutomaticPaymentMethods.html index 90e805b..03e744b 100644 --- a/docs/classes/AutomaticPaymentMethods.html +++ b/docs/classes/AutomaticPaymentMethods.html @@ -1,7 +1,7 @@ AutomaticPaymentMethods | react-native-tpay
              react-native-tpay
                Preparing search index...

                Class AutomaticPaymentMethods

                Class responsible for storing information about payer's automatic payment methods

                -
                Index

                Constructors

                Index

                Constructors

                Properties

                Constructors

                Properties

                blikAlias: BlikAlias | null
                tokenizedCards: TokenizedCard[] | null
                +

                Returns AutomaticPaymentMethods

                Properties

                blikAlias: BlikAlias | null
                tokenizedCards: TokenizedCard[] | null
                diff --git a/docs/classes/BlikAlias.html b/docs/classes/BlikAlias.html index 2967d15..c9096d9 100644 --- a/docs/classes/BlikAlias.html +++ b/docs/classes/BlikAlias.html @@ -1,9 +1,9 @@ BlikAlias | react-native-tpay
                react-native-tpay
                  Preparing search index...

                  Class BlikAlias

                  Class responsible for storing information about BLIK alias

                  -
                  Index

                  Constructors

                  Index

                  Constructors

                  Properties

                  Constructors

                  • Parameters

                    • isRegistered: boolean

                      true if this BLIK alias is registered (payer saved it after paying with 6-digit code)

                    • value: string

                      payer's unique alias value

                    • label: string

                      alias display name

                      -

                    Returns BlikAlias

                  Properties

                  isRegistered: boolean
                  label: string
                  value: string
                  +

                  Returns BlikAlias

                  Properties

                  isRegistered: boolean
                  label: string
                  value: string
                  diff --git a/docs/classes/BlikPayment.html b/docs/classes/BlikPayment.html index 823f20a..bc349c0 100644 --- a/docs/classes/BlikPayment.html +++ b/docs/classes/BlikPayment.html @@ -1,5 +1,5 @@ BlikPayment | react-native-tpay
                  react-native-tpay
                    Preparing search index...

                    Class BlikPayment

                    Class responsible for storing BLIK payment information

                    -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    Properties

                    alias callbacks code @@ -9,4 +9,4 @@ If you provide both, module will try to register the alias.

                    Parameters

                    Returns BlikPayment

                    Properties

                    alias: BlikAlias | null
                    callbacks: Callbacks
                    code: string | null
                    payer: Payer
                    paymentDetails: PaymentDetails
                    +
                  • paymentDetails: PaymentDetails
                  • payer: Payer
                  • callbacks: Callbacks
                  • Returns BlikPayment

                    Properties

                    alias: BlikAlias | null
                    callbacks: Callbacks
                    code: string | null
                    payer: Payer
                    paymentDetails: PaymentDetails
                    diff --git a/docs/classes/Callbacks.html b/docs/classes/Callbacks.html index 299a13d..2e22c9e 100644 --- a/docs/classes/Callbacks.html +++ b/docs/classes/Callbacks.html @@ -1,7 +1,7 @@ Callbacks | react-native-tpay
                    react-native-tpay
                      Preparing search index...

                      Class Callbacks

                      Class storing the information about callbacks

                      -
                      Index

                      Constructors

                      Index

                      Constructors

                      Properties

                      Constructors

                      Properties

                      notifications: Notifications | null
                      redirects: Redirects | null
                      +

                      Returns Callbacks

                      Properties

                      notifications: Notifications | null
                      redirects: Redirects | null
                      diff --git a/docs/classes/CertificatePinningConfiguration.html b/docs/classes/CertificatePinningConfiguration.html index 9e794c7..449702a 100644 --- a/docs/classes/CertificatePinningConfiguration.html +++ b/docs/classes/CertificatePinningConfiguration.html @@ -1,6 +1,6 @@ CertificatePinningConfiguration | react-native-tpay
                      react-native-tpay
                        Preparing search index...

                        Class CertificatePinningConfiguration

                        Class responsible for storing information about certificate pinning.

                        -
                        Index

                        Constructors

                        Index

                        Constructors

                        Properties

                        Constructors

                        Properties

                        pinnedDomain: string
                        publicKeyHash: string
                        +

                        Returns CertificatePinningConfiguration

                        Properties

                        pinnedDomain: string
                        publicKeyHash: string
                        diff --git a/docs/classes/ConfigurationSuccess.html b/docs/classes/ConfigurationSuccess.html index 0c62498..9e05615 100644 --- a/docs/classes/ConfigurationSuccess.html +++ b/docs/classes/ConfigurationSuccess.html @@ -1,11 +1,11 @@ ConfigurationSuccess | react-native-tpay
                        react-native-tpay
                          Preparing search index...

                          Class ConfigurationSuccess

                          Indicates that configuration was successful

                          -

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          Properties

                          message?: string

                          Optional error message or additional information

                          -
                          paymentUrl?: string

                          Payment URL for continuation (used in screenless payments)

                          -
                          transactionId?: string | null

                          Transaction ID when applicable

                          -
                          type: "configurationSuccess" = 'configurationSuccess'

                          Type identifier for the result

                          -
                          +
                          paymentUrl?: string

                          Payment URL for continuation (used in screenless payments)

                          +
                          transactionId?: string | null

                          Transaction ID when applicable

                          +
                          type: "configurationSuccess" = 'configurationSuccess'

                          Type identifier for the result

                          +
                          diff --git a/docs/classes/CreditCard.html b/docs/classes/CreditCard.html index 427219e..d153d4c 100644 --- a/docs/classes/CreditCard.html +++ b/docs/classes/CreditCard.html @@ -1,5 +1,5 @@ CreditCard | react-native-tpay
                          react-native-tpay
                            Preparing search index...

                            Class CreditCard

                            Class responsible for storing information about a credit card

                            -
                            Index

                            Constructors

                            Index

                            Constructors

                            Properties

                            cardNumber config cvv @@ -8,4 +8,4 @@
                          • expiryDate: ExpirationDate

                            credit card expiration date

                          • cvv: string

                            cvv code

                          • config: CreditCardConfig

                            other credit card information

                            -
                          • Returns CreditCard

                            Properties

                            cardNumber: string
                            cvv: string
                            expiryDate: ExpirationDate
                            +

                            Returns CreditCard

                            Properties

                            cardNumber: string
                            cvv: string
                            expiryDate: ExpirationDate
                            diff --git a/docs/classes/CreditCardConfig.html b/docs/classes/CreditCardConfig.html index 477ab49..7938ed5 100644 --- a/docs/classes/CreditCardConfig.html +++ b/docs/classes/CreditCardConfig.html @@ -1,8 +1,8 @@ CreditCardConfig | react-native-tpay
                            react-native-tpay
                              Preparing search index...

                              Class CreditCardConfig

                              Class responsible for storing payment related information about credit card

                              -
                              Index

                              Constructors

                              Index

                              Constructors

                              Properties

                              Constructors

                              Properties

                              domain: string
                              rocText: string | null
                              shouldSave: boolean
                              +
                            • rocText: string | null
                            • Returns CreditCardConfig

                              Properties

                              domain: string
                              rocText: string | null
                              shouldSave: boolean
                              diff --git a/docs/classes/CreditCardPayment.html b/docs/classes/CreditCardPayment.html index 65195ef..2eb9b7b 100644 --- a/docs/classes/CreditCardPayment.html +++ b/docs/classes/CreditCardPayment.html @@ -1,5 +1,5 @@ CreditCardPayment | react-native-tpay
                              react-native-tpay
                                Preparing search index...

                                Class CreditCardPayment

                                Class responsible for storing information about credit card payment

                                -

                                Hierarchy (View Summary)

                                Index

                                Constructors

                                Hierarchy (View Summary)

                                Index

                                Constructors

                                Properties

                                callbacks creditCard creditCardToken @@ -9,4 +9,4 @@ If you provide both, creditCardToken will be used.

                                Parameters

                                • creditCard: CreditCard | null

                                  information about credit card

                                • creditCardToken: string | null

                                  token of tokenized card (for returning customers)

                                  -
                                • paymentDetails: PaymentDetails
                                • payer: Payer
                                • callbacks: Callbacks

                                Returns CreditCardPayment

                                Properties

                                callbacks: Callbacks
                                creditCard: CreditCard | null
                                creditCardToken: string | null
                                payer: Payer
                                paymentDetails: PaymentDetails
                                +
                              • paymentDetails: PaymentDetails
                              • payer: Payer
                              • callbacks: Callbacks
                              • Returns CreditCardPayment

                                Properties

                                callbacks: Callbacks
                                creditCard: CreditCard | null
                                creditCardToken: string | null
                                payer: Payer
                                paymentDetails: PaymentDetails
                                diff --git a/docs/classes/ExpirationDate.html b/docs/classes/ExpirationDate.html index ea5ead2..2362157 100644 --- a/docs/classes/ExpirationDate.html +++ b/docs/classes/ExpirationDate.html @@ -1,7 +1,7 @@ ExpirationDate | react-native-tpay
                                react-native-tpay
                                  Preparing search index...

                                  Class ExpirationDate

                                  Class responsible for storing information about expiration date

                                  -
                                  Index

                                  Constructors

                                  Index

                                  Constructors

                                  Properties

                                  Constructors

                                  Properties

                                  month: String
                                  year: String
                                  +

                                  Returns ExpirationDate

                                  Properties

                                  month: String
                                  year: String
                                  diff --git a/docs/classes/GooglePayConfiguration.html b/docs/classes/GooglePayConfiguration.html index 7e70cb2..4b89002 100644 --- a/docs/classes/GooglePayConfiguration.html +++ b/docs/classes/GooglePayConfiguration.html @@ -1,5 +1,5 @@ GooglePayConfiguration | react-native-tpay
                                  react-native-tpay
                                    Preparing search index...

                                    Class GooglePayConfiguration

                                    Class responsible for storing information about GooglePay configuration

                                    -
                                    Index

                                    Constructors

                                    Index

                                    Constructors

                                    Properties

                                    Constructors

                                    Properties

                                    merchantId: string
                                    +

                                    Returns GooglePayConfiguration

                                    Properties

                                    merchantId: string
                                    diff --git a/docs/classes/GooglePayConfigureError.html b/docs/classes/GooglePayConfigureError.html index 67d6cce..c010980 100644 --- a/docs/classes/GooglePayConfigureError.html +++ b/docs/classes/GooglePayConfigureError.html @@ -1,7 +1,7 @@ GooglePayConfigureError | react-native-tpay
                                    react-native-tpay
                                      Preparing search index...

                                      Class GooglePayConfigureError

                                      Indicates that there was an error during Google Pay configuration

                                      -

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      Properties

                                      Constructors

                                      Properties

                                      message: string

                                      Error message

                                      -
                                      type: "error" = 'error'

                                      Type identifier for the result

                                      -
                                      +

                                      Constructors

                                      Properties

                                      message: string

                                      Error message

                                      +
                                      type: "error" = 'error'

                                      Type identifier for the result

                                      +
                                      diff --git a/docs/classes/GooglePayConfigureResult.html b/docs/classes/GooglePayConfigureResult.html index 7f5997d..f29bab6 100644 --- a/docs/classes/GooglePayConfigureResult.html +++ b/docs/classes/GooglePayConfigureResult.html @@ -1,7 +1,7 @@ GooglePayConfigureResult | react-native-tpay
                                      react-native-tpay
                                        Preparing search index...

                                        Class GooglePayConfigureResultAbstract

                                        Indicates a result of Google Pay configuration

                                        -

                                        Hierarchy (View Summary)

                                        Index

                                        Constructors

                                        Hierarchy (View Summary)

                                        Index

                                        Constructors

                                        Properties

                                        Constructors

                                        Properties

                                        message?: string

                                        Optional error message or additional information

                                        -
                                        type: string

                                        Type identifier for the result

                                        -
                                        +
                                        type: string

                                        Type identifier for the result

                                        +
                                        diff --git a/docs/classes/GooglePayConfigureSuccess.html b/docs/classes/GooglePayConfigureSuccess.html index 8b8f917..cc10707 100644 --- a/docs/classes/GooglePayConfigureSuccess.html +++ b/docs/classes/GooglePayConfigureSuccess.html @@ -1,7 +1,7 @@ GooglePayConfigureSuccess | react-native-tpay
                                        react-native-tpay
                                          Preparing search index...

                                          Class GooglePayConfigureSuccess

                                          Indicates that Google Pay configuration was successful

                                          -

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          Properties

                                          Constructors

                                          Properties

                                          message?: string

                                          Optional error message or additional information

                                          -
                                          type: "success" = 'success'

                                          Type identifier for the result

                                          -
                                          +
                                          type: "success" = 'success'

                                          Type identifier for the result

                                          +
                                          diff --git a/docs/classes/GooglePayOpenCancelled.html b/docs/classes/GooglePayOpenCancelled.html index 9e722a7..c4c07a1 100644 --- a/docs/classes/GooglePayOpenCancelled.html +++ b/docs/classes/GooglePayOpenCancelled.html @@ -1,13 +1,13 @@ GooglePayOpenCancelled | react-native-tpay
                                          react-native-tpay
                                            Preparing search index...

                                            Class GooglePayOpenCancelled

                                            Indicates that Google Pay was opened successfully but user closed it without selecting a credit card

                                            -

                                            Hierarchy (View Summary)

                                            Index

                                            Constructors

                                            Hierarchy (View Summary)

                                            Index

                                            Constructors

                                            Properties

                                            cardNetwork?: string

                                            Credit card network when available

                                            -
                                            cardTail?: string

                                            Last digits of credit card number when available

                                            -
                                            description?: string

                                            Credit card description when available

                                            -
                                            token?: string

                                            Google Pay card token when available

                                            -
                                            type: "cancelled" = 'cancelled'

                                            Type identifier for the result

                                            -
                                            +
                                            cardTail?: string

                                            Last digits of credit card number when available

                                            +
                                            description?: string

                                            Credit card description when available

                                            +
                                            token?: string

                                            Google Pay card token when available

                                            +
                                            type: "cancelled" = 'cancelled'

                                            Type identifier for the result

                                            +
                                            diff --git a/docs/classes/GooglePayOpenNotConfigured.html b/docs/classes/GooglePayOpenNotConfigured.html index 4b2a5b8..ac8a809 100644 --- a/docs/classes/GooglePayOpenNotConfigured.html +++ b/docs/classes/GooglePayOpenNotConfigured.html @@ -1,14 +1,14 @@ GooglePayOpenNotConfigured | react-native-tpay
                                            react-native-tpay
                                              Preparing search index...

                                              Class GooglePayOpenNotConfigured

                                              Indicates that Google Pay utils were not configured before trying to open Google Pay. Configure utils via configureGooglePayUtils(...) method

                                              -

                                              Hierarchy (View Summary)

                                              Index

                                              Constructors

                                              Hierarchy (View Summary)

                                              Index

                                              Constructors

                                              Properties

                                              cardNetwork?: string

                                              Credit card network when available

                                              -
                                              cardTail?: string

                                              Last digits of credit card number when available

                                              -
                                              description?: string

                                              Credit card description when available

                                              -
                                              token?: string

                                              Google Pay card token when available

                                              -
                                              type: "notConfigured" = 'notConfigured'

                                              Type identifier for the result

                                              -
                                              +
                                              cardTail?: string

                                              Last digits of credit card number when available

                                              +
                                              description?: string

                                              Credit card description when available

                                              +
                                              token?: string

                                              Google Pay card token when available

                                              +
                                              type: "notConfigured" = 'notConfigured'

                                              Type identifier for the result

                                              +
                                              diff --git a/docs/classes/GooglePayOpenResult.html b/docs/classes/GooglePayOpenResult.html index 404a470..c052a04 100644 --- a/docs/classes/GooglePayOpenResult.html +++ b/docs/classes/GooglePayOpenResult.html @@ -1,13 +1,13 @@ GooglePayOpenResult | react-native-tpay
                                              react-native-tpay
                                                Preparing search index...

                                                Class GooglePayOpenResultAbstract

                                                Indicates a result of Google Pay open

                                                -

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                Properties

                                                cardNetwork?: string

                                                Credit card network when available

                                                -
                                                cardTail?: string

                                                Last digits of credit card number when available

                                                -
                                                description?: string

                                                Credit card description when available

                                                -
                                                token?: string

                                                Google Pay card token when available

                                                -
                                                type: string

                                                Type identifier for the result

                                                -
                                                +
                                                cardTail?: string

                                                Last digits of credit card number when available

                                                +
                                                description?: string

                                                Credit card description when available

                                                +
                                                token?: string

                                                Google Pay card token when available

                                                +
                                                type: string

                                                Type identifier for the result

                                                +
                                                diff --git a/docs/classes/GooglePayOpenSuccess.html b/docs/classes/GooglePayOpenSuccess.html index 93e3f34..535d02c 100644 --- a/docs/classes/GooglePayOpenSuccess.html +++ b/docs/classes/GooglePayOpenSuccess.html @@ -1,13 +1,13 @@ GooglePayOpenSuccess | react-native-tpay
                                                react-native-tpay
                                                  Preparing search index...

                                                  Class GooglePayOpenSuccess

                                                  Indicates that Google Pay was successfully opened and user has selected a credit card

                                                  -

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  Properties

                                                  cardNetwork: string

                                                  Credit card network

                                                  -
                                                  cardTail: string

                                                  Last digits of credit card number

                                                  -
                                                  description: string

                                                  Credit card description, for example "Visa •••• 1111"

                                                  -
                                                  token: string

                                                  Google Pay card token, use it with GooglePayPayment

                                                  -
                                                  type: "success" = 'success'

                                                  Type identifier for the result

                                                  -
                                                  +

                                                  Constructors

                                                  Properties

                                                  cardNetwork: string

                                                  Credit card network

                                                  +
                                                  cardTail: string

                                                  Last digits of credit card number

                                                  +
                                                  description: string

                                                  Credit card description, for example "Visa •••• 1111"

                                                  +
                                                  token: string

                                                  Google Pay card token, use it with GooglePayPayment

                                                  +
                                                  type: "success" = 'success'

                                                  Type identifier for the result

                                                  +
                                                  diff --git a/docs/classes/GooglePayOpenUnknownError.html b/docs/classes/GooglePayOpenUnknownError.html index b08726c..a071eb5 100644 --- a/docs/classes/GooglePayOpenUnknownError.html +++ b/docs/classes/GooglePayOpenUnknownError.html @@ -1,13 +1,13 @@ GooglePayOpenUnknownError | react-native-tpay
                                                  react-native-tpay
                                                    Preparing search index...

                                                    Class GooglePayOpenUnknownError

                                                    Indicates that there was a unknown error

                                                    -

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    Properties

                                                    cardNetwork?: string

                                                    Credit card network when available

                                                    -
                                                    cardTail?: string

                                                    Last digits of credit card number when available

                                                    -
                                                    description?: string

                                                    Credit card description when available

                                                    -
                                                    token?: string

                                                    Google Pay card token when available

                                                    -
                                                    type: "unknownError" = 'unknownError'

                                                    Type identifier for the result

                                                    -
                                                    +
                                                    cardTail?: string

                                                    Last digits of credit card number when available

                                                    +
                                                    description?: string

                                                    Credit card description when available

                                                    +
                                                    token?: string

                                                    Google Pay card token when available

                                                    +
                                                    type: "unknownError" = 'unknownError'

                                                    Type identifier for the result

                                                    +
                                                    diff --git a/docs/classes/GooglePayPayment.html b/docs/classes/GooglePayPayment.html index f60197d..23d3b79 100644 --- a/docs/classes/GooglePayPayment.html +++ b/docs/classes/GooglePayPayment.html @@ -1,8 +1,8 @@ GooglePayPayment | react-native-tpay
                                                    react-native-tpay
                                                      Preparing search index...

                                                      Class GooglePayPayment

                                                      Class responsible for storing information about Google Pay payment

                                                      -

                                                      Hierarchy (View Summary)

                                                      Index

                                                      Constructors

                                                      Hierarchy (View Summary)

                                                      Index

                                                      Constructors

                                                      Properties

                                                      callbacks: Callbacks
                                                      payer: Payer
                                                      paymentDetails: PaymentDetails
                                                      token: string
                                                      +
                                                    • paymentDetails: PaymentDetails
                                                    • payer: Payer
                                                    • callbacks: Callbacks
                                                    • Returns GooglePayPayment

                                                      Properties

                                                      callbacks: Callbacks
                                                      payer: Payer
                                                      paymentDetails: PaymentDetails
                                                      token: string
                                                      diff --git a/docs/classes/GooglePayUtilsConfiguration.html b/docs/classes/GooglePayUtilsConfiguration.html index 7c2657c..b798b0e 100644 --- a/docs/classes/GooglePayUtilsConfiguration.html +++ b/docs/classes/GooglePayUtilsConfiguration.html @@ -1,5 +1,5 @@ GooglePayUtilsConfiguration | react-native-tpay
                                                      react-native-tpay
                                                        Preparing search index...

                                                        Class GooglePayUtilsConfiguration

                                                        Class responsible for storing information about Google Pay utils configuration

                                                        -
                                                        Index

                                                        Constructors

                                                        Index

                                                        Constructors

                                                        Properties

                                                      • merchantId: string

                                                        your merchantId in Tpay system

                                                      • environment: GooglePayEnvironment

                                                        Google Pay environment

                                                      • customRequestCode: number | null

                                                        alternative request code that will be used to manage Google Pay data

                                                        -
                                                      • Returns GooglePayUtilsConfiguration

                                                        Properties

                                                        customRequestCode: number | null
                                                        merchantId: string
                                                        merchantName: string
                                                        price: number
                                                        +

                                                        Returns GooglePayUtilsConfiguration

                                                        Properties

                                                        customRequestCode: number | null
                                                        merchantId: string
                                                        merchantName: string
                                                        price: number
                                                        diff --git a/docs/classes/Languages.html b/docs/classes/Languages.html index c650e33..7e052a9 100644 --- a/docs/classes/Languages.html +++ b/docs/classes/Languages.html @@ -1,7 +1,7 @@ Languages | react-native-tpay
                                                        react-native-tpay
                                                          Preparing search index...

                                                          Class Languages

                                                          Class responsible for storing information about module languages.

                                                          -
                                                          Index

                                                          Constructors

                                                          Index

                                                          Constructors

                                                          Properties

                                                          preferredLanguage: Language
                                                          supportedLanguages: Language[]
                                                          +

                                                          Returns Languages

                                                          Properties

                                                          preferredLanguage: Language
                                                          supportedLanguages: Language[]
                                                          diff --git a/docs/classes/LocalizedString.html b/docs/classes/LocalizedString.html index 5640ddb..9d8f7e6 100644 --- a/docs/classes/LocalizedString.html +++ b/docs/classes/LocalizedString.html @@ -1,5 +1,5 @@ LocalizedString | react-native-tpay
                                                          react-native-tpay
                                                            Preparing search index...

                                                            Class LocalizedString

                                                            Class responsible for storing a localized string

                                                            -
                                                            Index

                                                            Constructors

                                                            Index

                                                            Constructors

                                                            Properties

                                                            Constructors

                                                            Properties

                                                            language: Language
                                                            value: string
                                                            +

                                                            Constructors

                                                            Properties

                                                            language: Language
                                                            value: string
                                                            diff --git a/docs/classes/Merchant.html b/docs/classes/Merchant.html index 523fdde..233ef8a 100644 --- a/docs/classes/Merchant.html +++ b/docs/classes/Merchant.html @@ -1,5 +1,5 @@ Merchant | react-native-tpay
                                                            react-native-tpay
                                                              Preparing search index...

                                                              Class Merchant

                                                              Class responsible for storing merchant information

                                                              -
                                                              Index

                                                              Constructors

                                                              Index

                                                              Constructors

                                                              Properties

                                                            • certificatePinningConfiguration: CertificatePinningConfiguration

                                                              encryption information

                                                            • blikAliasToRegister: string

                                                              BLIK that will be registered with payment

                                                            • walletConfiguration: WalletConfiguration | null

                                                              configuration of digital wallets

                                                              -
                                                            • Returns Merchant

                                                              Properties

                                                              authorization: MerchantAuthorization
                                                              blikAliasToRegister: string
                                                              certificatePinningConfiguration: CertificatePinningConfiguration
                                                              environment: TpayEnvironment
                                                              walletConfiguration: WalletConfiguration | null
                                                              +

                                                              Returns Merchant

                                                              Properties

                                                              authorization: MerchantAuthorization
                                                              blikAliasToRegister: string
                                                              certificatePinningConfiguration: CertificatePinningConfiguration
                                                              environment: TpayEnvironment
                                                              walletConfiguration: WalletConfiguration | null
                                                              diff --git a/docs/classes/MerchantAuthorization.html b/docs/classes/MerchantAuthorization.html index 17f5171..5a0e7ac 100644 --- a/docs/classes/MerchantAuthorization.html +++ b/docs/classes/MerchantAuthorization.html @@ -1,7 +1,7 @@ MerchantAuthorization | react-native-tpay
                                                              react-native-tpay
                                                                Preparing search index...

                                                                Class MerchantAuthorization

                                                                Class responsible for storing merchant's authorization

                                                                -
                                                                Index

                                                                Constructors

                                                                Index

                                                                Constructors

                                                                Properties

                                                                Constructors

                                                                Properties

                                                                clientId: string
                                                                clientSecret: string
                                                                +

                                                                Returns MerchantAuthorization

                                                                Properties

                                                                clientId: string
                                                                clientSecret: string
                                                                diff --git a/docs/classes/MerchantDetails.html b/docs/classes/MerchantDetails.html index e4e7781..e4ff151 100644 --- a/docs/classes/MerchantDetails.html +++ b/docs/classes/MerchantDetails.html @@ -1,9 +1,9 @@ MerchantDetails | react-native-tpay
                                                                react-native-tpay
                                                                  Preparing search index...

                                                                  Class MerchantDetails

                                                                  Class responsible for storing localized information about merchant

                                                                  -
                                                                  Index

                                                                  Constructors

                                                                  Index

                                                                  Constructors

                                                                  Properties

                                                                  merchantDisplayName: LocalizedString[]
                                                                  merchantHeadquarters: LocalizedString[]
                                                                  regulations: LocalizedString[]
                                                                  +

                                                                  Returns MerchantDetails

                                                                  Properties

                                                                  merchantDisplayName: LocalizedString[]
                                                                  merchantHeadquarters: LocalizedString[]
                                                                  regulations: LocalizedString[]
                                                                  diff --git a/docs/classes/MethodCallError.html b/docs/classes/MethodCallError.html index 7f79118..adde7cb 100644 --- a/docs/classes/MethodCallError.html +++ b/docs/classes/MethodCallError.html @@ -1,11 +1,11 @@ MethodCallError | react-native-tpay
                                                                  react-native-tpay
                                                                    Preparing search index...

                                                                    Class MethodCallError

                                                                    Indicates a module error

                                                                    -

                                                                    Hierarchy (View Summary)

                                                                    Index

                                                                    Constructors

                                                                    Hierarchy (View Summary)

                                                                    Index

                                                                    Constructors

                                                                    Properties

                                                                    message: string

                                                                    Error message

                                                                    -
                                                                    paymentUrl?: string

                                                                    Payment URL for continuation (used in screenless payments)

                                                                    -
                                                                    transactionId?: string | null

                                                                    Transaction ID when applicable

                                                                    -
                                                                    type: "methodCallError" = 'methodCallError'

                                                                    Type identifier for the result

                                                                    -
                                                                    +

                                                                    Constructors

                                                                    Properties

                                                                    message: string

                                                                    Error message

                                                                    +
                                                                    paymentUrl?: string

                                                                    Payment URL for continuation (used in screenless payments)

                                                                    +
                                                                    transactionId?: string | null

                                                                    Transaction ID when applicable

                                                                    +
                                                                    type: "methodCallError" = 'methodCallError'

                                                                    Type identifier for the result

                                                                    +
                                                                    diff --git a/docs/classes/ModuleClosed.html b/docs/classes/ModuleClosed.html index 0e5c497..2ab7fe6 100644 --- a/docs/classes/ModuleClosed.html +++ b/docs/classes/ModuleClosed.html @@ -1,11 +1,11 @@ ModuleClosed | react-native-tpay
                                                                    react-native-tpay
                                                                      Preparing search index...

                                                                      Class ModuleClosed

                                                                      Indicates that user closed the module without making a payment/tokenization

                                                                      -

                                                                      Hierarchy (View Summary)

                                                                      Index

                                                                      Constructors

                                                                      Hierarchy (View Summary)

                                                                      Index

                                                                      Constructors

                                                                      Properties

                                                                      message?: string

                                                                      Optional error message or additional information

                                                                      -
                                                                      paymentUrl?: string

                                                                      Payment URL for continuation (used in screenless payments)

                                                                      -
                                                                      transactionId?: string | null

                                                                      Transaction ID when applicable

                                                                      -
                                                                      type: "moduleClosed" = 'moduleClosed'

                                                                      Type identifier for the result

                                                                      -
                                                                      +
                                                                      paymentUrl?: string

                                                                      Payment URL for continuation (used in screenless payments)

                                                                      +
                                                                      transactionId?: string | null

                                                                      Transaction ID when applicable

                                                                      +
                                                                      type: "moduleClosed" = 'moduleClosed'

                                                                      Type identifier for the result

                                                                      +
                                                                      diff --git a/docs/classes/Notifications.html b/docs/classes/Notifications.html index 6676d62..3c74d5b 100644 --- a/docs/classes/Notifications.html +++ b/docs/classes/Notifications.html @@ -1,7 +1,7 @@ Notifications | react-native-tpay
                                                                      react-native-tpay
                                                                        Preparing search index...

                                                                        Class Notifications

                                                                        Class responsible for storing information about notifications

                                                                        -
                                                                        Index

                                                                        Constructors

                                                                        Index

                                                                        Constructors

                                                                        Properties

                                                                        Constructors

                                                                        Properties

                                                                        email: string
                                                                        url: string
                                                                        +

                                                                        Returns Notifications

                                                                        Properties

                                                                        email: string
                                                                        url: string
                                                                        diff --git a/docs/classes/PayPoPayment.html b/docs/classes/PayPoPayment.html index e080221..5aef093 100644 --- a/docs/classes/PayPoPayment.html +++ b/docs/classes/PayPoPayment.html @@ -1,6 +1,6 @@ PayPoPayment | react-native-tpay
                                                                        react-native-tpay
                                                                          Preparing search index...

                                                                          Class PayPoPayment

                                                                          Class responsible for storing information about PayPo payment

                                                                          -

                                                                          Hierarchy (View Summary)

                                                                          Index

                                                                          Constructors

                                                                          Hierarchy (View Summary)

                                                                          Index

                                                                          Constructors

                                                                          Properties

                                                                          Constructors

                                                                          Properties

                                                                          callbacks: Callbacks
                                                                          payer: Payer
                                                                          paymentDetails: PaymentDetails
                                                                          +

                                                                          Constructors

                                                                          Properties

                                                                          callbacks: Callbacks
                                                                          payer: Payer
                                                                          paymentDetails: PaymentDetails
                                                                          diff --git a/docs/classes/Payer.html b/docs/classes/Payer.html index 4d4cdfa..f8d99cf 100644 --- a/docs/classes/Payer.html +++ b/docs/classes/Payer.html @@ -1,5 +1,5 @@ Payer | react-native-tpay
                                                                          react-native-tpay
                                                                            Preparing search index...

                                                                            Class Payer

                                                                            Class responsible for storing information about payer

                                                                            -
                                                                            Index

                                                                            Constructors

                                                                            Index

                                                                            Constructors

                                                                            Properties

                                                                            address email name @@ -8,4 +8,4 @@
                                                                          • email: string

                                                                            payer's email

                                                                          • phone: string | null

                                                                            payer's phone number

                                                                          • address: Address | null

                                                                            payer's address

                                                                            -
                                                                          • Returns Payer

                                                                            Properties

                                                                            address: Address | null
                                                                            email: string
                                                                            name: string
                                                                            phone: string | null
                                                                            +

                                                                            Returns Payer

                                                                            Properties

                                                                            address: Address | null
                                                                            email: string
                                                                            name: string
                                                                            phone: string | null
                                                                            diff --git a/docs/classes/PayerContext.html b/docs/classes/PayerContext.html index b49920b..ef58622 100644 --- a/docs/classes/PayerContext.html +++ b/docs/classes/PayerContext.html @@ -1,7 +1,7 @@ PayerContext | react-native-tpay
                                                                            react-native-tpay
                                                                              Preparing search index...

                                                                              Class PayerContext

                                                                              Class responsible for storing information about payer and automatic payment methods

                                                                              -
                                                                              Index

                                                                              Constructors

                                                                              Index

                                                                              Constructors

                                                                              Properties

                                                                              automaticPaymentMethods: AutomaticPaymentMethods | null
                                                                              payer: Payer | null
                                                                              +

                                                                              Returns PayerContext

                                                                              Properties

                                                                              automaticPaymentMethods: AutomaticPaymentMethods | null
                                                                              payer: Payer | null
                                                                              diff --git a/docs/classes/PaymentCancelled.html b/docs/classes/PaymentCancelled.html index 8d2c6d9..0439d0a 100644 --- a/docs/classes/PaymentCancelled.html +++ b/docs/classes/PaymentCancelled.html @@ -1,11 +1,11 @@ PaymentCancelled | react-native-tpay
                                                                              react-native-tpay
                                                                                Preparing search index...

                                                                                Class PaymentCancelled

                                                                                Indicates that payment failed and module was closed

                                                                                -

                                                                                Hierarchy (View Summary)

                                                                                Index

                                                                                Constructors

                                                                                Hierarchy (View Summary)

                                                                                Index

                                                                                Constructors

                                                                                Properties

                                                                                message?: string

                                                                                Optional error message or additional information

                                                                                -
                                                                                paymentUrl?: string

                                                                                Payment URL for continuation (used in screenless payments)

                                                                                -
                                                                                transactionId: string | null

                                                                                If exists, id of the transaction

                                                                                -
                                                                                type: "paymentCancelled" = 'paymentCancelled'

                                                                                Type identifier for the result

                                                                                -
                                                                                +

                                                                                Constructors

                                                                                Properties

                                                                                message?: string

                                                                                Optional error message or additional information

                                                                                +
                                                                                paymentUrl?: string

                                                                                Payment URL for continuation (used in screenless payments)

                                                                                +
                                                                                transactionId: string | null

                                                                                If exists, id of the transaction

                                                                                +
                                                                                type: "paymentCancelled" = 'paymentCancelled'

                                                                                Type identifier for the result

                                                                                +
                                                                                diff --git a/docs/classes/PaymentChannel.html b/docs/classes/PaymentChannel.html index a7d65cf..23c442e 100644 --- a/docs/classes/PaymentChannel.html +++ b/docs/classes/PaymentChannel.html @@ -1,11 +1,11 @@ PaymentChannel | react-native-tpay
                                                                                react-native-tpay
                                                                                  Preparing search index...

                                                                                  Class PaymentChannel

                                                                                  Class responsible for storing information about a payment channel

                                                                                  -
                                                                                  Index

                                                                                  Constructors

                                                                                  Index

                                                                                  Constructors

                                                                                  Properties

                                                                                  Constructors

                                                                                  Properties

                                                                                  constraints: PaymentConstraint[]

                                                                                  channel constraints

                                                                                  -
                                                                                  id: string

                                                                                  id of the payment channel

                                                                                  -
                                                                                  imageUrl: string

                                                                                  channel image url

                                                                                  -
                                                                                  name: string

                                                                                  channel display name

                                                                                  -
                                                                                  +

                                                                                  Constructors

                                                                                  Properties

                                                                                  constraints: PaymentConstraint[]

                                                                                  channel constraints

                                                                                  +
                                                                                  id: string

                                                                                  id of the payment channel

                                                                                  +
                                                                                  imageUrl: string

                                                                                  channel image url

                                                                                  +
                                                                                  name: string

                                                                                  channel display name

                                                                                  +
                                                                                  diff --git a/docs/classes/PaymentChannelsError.html b/docs/classes/PaymentChannelsError.html index 207ff06..dbb461d 100644 --- a/docs/classes/PaymentChannelsError.html +++ b/docs/classes/PaymentChannelsError.html @@ -1,9 +1,9 @@ PaymentChannelsError | react-native-tpay
                                                                                  react-native-tpay
                                                                                    Preparing search index...

                                                                                    Class PaymentChannelsError

                                                                                    Indicates that there was an error while fetching payment channels

                                                                                    -

                                                                                    Hierarchy (View Summary)

                                                                                    Index

                                                                                    Constructors

                                                                                    Hierarchy (View Summary)

                                                                                    Index

                                                                                    Constructors

                                                                                    Properties

                                                                                    Constructors

                                                                                    Properties

                                                                                    channels?: PaymentChannel[]

                                                                                    Payment channels array when available

                                                                                    -
                                                                                    message: string

                                                                                    Error message

                                                                                    -
                                                                                    type: "error" = 'error'

                                                                                    Type identifier for the result

                                                                                    -
                                                                                    +

                                                                                    Constructors

                                                                                    Properties

                                                                                    channels?: PaymentChannel[]

                                                                                    Payment channels array when available

                                                                                    +
                                                                                    message: string

                                                                                    Error message

                                                                                    +
                                                                                    type: "error" = 'error'

                                                                                    Type identifier for the result

                                                                                    +
                                                                                    diff --git a/docs/classes/PaymentChannelsResult.html b/docs/classes/PaymentChannelsResult.html index af8a365..4ca0629 100644 --- a/docs/classes/PaymentChannelsResult.html +++ b/docs/classes/PaymentChannelsResult.html @@ -1,9 +1,9 @@ PaymentChannelsResult | react-native-tpay
                                                                                    react-native-tpay
                                                                                      Preparing search index...

                                                                                      Class PaymentChannelsResultAbstract

                                                                                      Indicates a result of payment channels

                                                                                      -

                                                                                      Hierarchy (View Summary)

                                                                                      Index

                                                                                      Constructors

                                                                                      Hierarchy (View Summary)

                                                                                      Index

                                                                                      Constructors

                                                                                      Properties

                                                                                      Constructors

                                                                                      Properties

                                                                                      channels?: PaymentChannel[]

                                                                                      Payment channels array when available

                                                                                      -
                                                                                      message?: string

                                                                                      Optional error message or additional information

                                                                                      -
                                                                                      type: string

                                                                                      Type identifier for the result

                                                                                      -
                                                                                      +
                                                                                      message?: string

                                                                                      Optional error message or additional information

                                                                                      +
                                                                                      type: string

                                                                                      Type identifier for the result

                                                                                      +
                                                                                      diff --git a/docs/classes/PaymentChannelsSuccess.html b/docs/classes/PaymentChannelsSuccess.html index 67b4ff9..4fbfeda 100644 --- a/docs/classes/PaymentChannelsSuccess.html +++ b/docs/classes/PaymentChannelsSuccess.html @@ -1,9 +1,9 @@ PaymentChannelsSuccess | react-native-tpay
                                                                                      react-native-tpay
                                                                                        Preparing search index...

                                                                                        Class PaymentChannelsSuccess

                                                                                        Indicates that payment channels were successfully received

                                                                                        -

                                                                                        Hierarchy (View Summary)

                                                                                        Index

                                                                                        Constructors

                                                                                        Hierarchy (View Summary)

                                                                                        Index

                                                                                        Constructors

                                                                                        Properties

                                                                                        Constructors

                                                                                        Properties

                                                                                        channels: PaymentChannel[]

                                                                                        Payment channels

                                                                                        -
                                                                                        message?: string

                                                                                        Optional error message or additional information

                                                                                        -
                                                                                        type: "success" = 'success'

                                                                                        Type identifier for the result

                                                                                        -
                                                                                        +

                                                                                        Constructors

                                                                                        Properties

                                                                                        channels: PaymentChannel[]

                                                                                        Payment channels

                                                                                        +
                                                                                        message?: string

                                                                                        Optional error message or additional information

                                                                                        +
                                                                                        type: "success" = 'success'

                                                                                        Type identifier for the result

                                                                                        +
                                                                                        diff --git a/docs/classes/PaymentCompleted.html b/docs/classes/PaymentCompleted.html index 5c9ca10..825f75e 100644 --- a/docs/classes/PaymentCompleted.html +++ b/docs/classes/PaymentCompleted.html @@ -1,11 +1,11 @@ PaymentCompleted | react-native-tpay
                                                                                        react-native-tpay
                                                                                          Preparing search index...

                                                                                          Class PaymentCompleted

                                                                                          Indicates that payment was successful and module was closed

                                                                                          -

                                                                                          Hierarchy (View Summary)

                                                                                          Index

                                                                                          Constructors

                                                                                          Hierarchy (View Summary)

                                                                                          Index

                                                                                          Constructors

                                                                                          Properties

                                                                                          message?: string

                                                                                          Optional error message or additional information

                                                                                          -
                                                                                          paymentUrl?: string

                                                                                          Payment URL for continuation (used in screenless payments)

                                                                                          -
                                                                                          transactionId: string

                                                                                          Transaction id of the completed transaction

                                                                                          -
                                                                                          type: "paymentCompleted" = 'paymentCompleted'

                                                                                          Type identifier for the result

                                                                                          -
                                                                                          +

                                                                                          Constructors

                                                                                          Properties

                                                                                          message?: string

                                                                                          Optional error message or additional information

                                                                                          +
                                                                                          paymentUrl?: string

                                                                                          Payment URL for continuation (used in screenless payments)

                                                                                          +
                                                                                          transactionId: string

                                                                                          Transaction id of the completed transaction

                                                                                          +
                                                                                          type: "paymentCompleted" = 'paymentCompleted'

                                                                                          Type identifier for the result

                                                                                          +
                                                                                          diff --git a/docs/classes/PaymentConstraint.html b/docs/classes/PaymentConstraint.html index 443816b..538d4ca 100644 --- a/docs/classes/PaymentConstraint.html +++ b/docs/classes/PaymentConstraint.html @@ -1,5 +1,5 @@ PaymentConstraint | react-native-tpay
                                                                                          react-native-tpay
                                                                                            Preparing search index...

                                                                                            Class PaymentConstraint

                                                                                            Class indicating that there is a payment constraint on a payment channel

                                                                                            -

                                                                                            Hierarchy (View Summary)

                                                                                            Index

                                                                                            Constructors

                                                                                            Hierarchy (View Summary)

                                                                                            Index

                                                                                            Constructors

                                                                                            Properties

                                                                                            Constructors

                                                                                            Properties

                                                                                            type: amount

                                                                                            type of a payment constraint

                                                                                            -
                                                                                            +

                                                                                            Constructors

                                                                                            Properties

                                                                                            type: amount

                                                                                            type of a payment constraint

                                                                                            +
                                                                                            diff --git a/docs/classes/PaymentCreated.html b/docs/classes/PaymentCreated.html index 596de7b..92f824a 100644 --- a/docs/classes/PaymentCreated.html +++ b/docs/classes/PaymentCreated.html @@ -1,11 +1,11 @@ PaymentCreated | react-native-tpay
                                                                                            react-native-tpay
                                                                                              Preparing search index...

                                                                                              Class PaymentCreated

                                                                                              Indicates that payment was successfully created

                                                                                              -

                                                                                              Hierarchy (View Summary)

                                                                                              Index

                                                                                              Constructors

                                                                                              Hierarchy (View Summary)

                                                                                              Index

                                                                                              Constructors

                                                                                              Properties

                                                                                              message?: string

                                                                                              Optional error message or additional information

                                                                                              -
                                                                                              paymentUrl?: string

                                                                                              Payment URL for continuation (used in screenless payments)

                                                                                              -
                                                                                              transactionId: string

                                                                                              Transaction id of the created transaction

                                                                                              -
                                                                                              type: "paymentCreated" = 'paymentCreated'

                                                                                              Type identifier for the result

                                                                                              -
                                                                                              +

                                                                                              Constructors

                                                                                              Properties

                                                                                              message?: string

                                                                                              Optional error message or additional information

                                                                                              +
                                                                                              paymentUrl?: string

                                                                                              Payment URL for continuation (used in screenless payments)

                                                                                              +
                                                                                              transactionId: string

                                                                                              Transaction id of the created transaction

                                                                                              +
                                                                                              type: "paymentCreated" = 'paymentCreated'

                                                                                              Type identifier for the result

                                                                                              +
                                                                                              diff --git a/docs/classes/PaymentDetails.html b/docs/classes/PaymentDetails.html index 31656a7..9397630 100644 --- a/docs/classes/PaymentDetails.html +++ b/docs/classes/PaymentDetails.html @@ -1,5 +1,5 @@ PaymentDetails | react-native-tpay
                                                                                              react-native-tpay
                                                                                                Preparing search index...

                                                                                                Class PaymentDetails

                                                                                                Class responsible for storing information about payment details

                                                                                                -
                                                                                                Index

                                                                                                Constructors

                                                                                                Index

                                                                                                Constructors

                                                                                                Properties

                                                                                              • description: string

                                                                                                description of payment shown to payer

                                                                                              • hiddenDescription: string | null

                                                                                                description visible to store

                                                                                              • language: Language | null

                                                                                                language of the transaction

                                                                                                -
                                                                                              • Returns PaymentDetails

                                                                                                Properties

                                                                                                amount: number
                                                                                                description: string
                                                                                                hiddenDescription: string | null
                                                                                                language: Language | null
                                                                                                +

                                                                                                Returns PaymentDetails

                                                                                                Properties

                                                                                                amount: number
                                                                                                description: string
                                                                                                hiddenDescription: string | null
                                                                                                language: Language | null
                                                                                                diff --git a/docs/classes/PaymentGroup.html b/docs/classes/PaymentGroup.html index ed3fd1e..001e609 100644 --- a/docs/classes/PaymentGroup.html +++ b/docs/classes/PaymentGroup.html @@ -1,9 +1,9 @@ PaymentGroup | react-native-tpay
                                                                                                react-native-tpay
                                                                                                  Preparing search index...

                                                                                                  Class PaymentGroup

                                                                                                  Class responsible for storing payment group's information

                                                                                                  -
                                                                                                  Index

                                                                                                  Constructors

                                                                                                  Index

                                                                                                  Constructors

                                                                                                  Properties

                                                                                                  Constructors

                                                                                                  Properties

                                                                                                  id: string

                                                                                                  id of the group

                                                                                                  -
                                                                                                  imageUrl: string

                                                                                                  group's image url

                                                                                                  -
                                                                                                  name: string

                                                                                                  group's display name

                                                                                                  -
                                                                                                  +

                                                                                                  Constructors

                                                                                                  Properties

                                                                                                  id: string

                                                                                                  id of the group

                                                                                                  +
                                                                                                  imageUrl: string

                                                                                                  group's image url

                                                                                                  +
                                                                                                  name: string

                                                                                                  group's display name

                                                                                                  +
                                                                                                  diff --git a/docs/classes/PaymentMethods.html b/docs/classes/PaymentMethods.html index b7f1edf..5b55750 100644 --- a/docs/classes/PaymentMethods.html +++ b/docs/classes/PaymentMethods.html @@ -1,9 +1,9 @@ PaymentMethods | react-native-tpay
                                                                                                  react-native-tpay
                                                                                                    Preparing search index...

                                                                                                    Class PaymentMethods

                                                                                                    Class responsible for storing selected payment methods

                                                                                                    -
                                                                                                    Index

                                                                                                    Constructors

                                                                                                    Index

                                                                                                    Constructors

                                                                                                    Properties

                                                                                                    installmentPayments: InstallmentPayment[] | null
                                                                                                    methods: PaymentMethod[]
                                                                                                    wallets: DigitalWallet[] | null
                                                                                                    +

                                                                                                    Returns PaymentMethods

                                                                                                    Properties

                                                                                                    installmentPayments: InstallmentPayment[] | null
                                                                                                    methods: PaymentMethod[]
                                                                                                    wallets: DigitalWallet[] | null
                                                                                                    diff --git a/docs/classes/RatyPekaoPayment.html b/docs/classes/RatyPekaoPayment.html index d3a3236..ed55f3b 100644 --- a/docs/classes/RatyPekaoPayment.html +++ b/docs/classes/RatyPekaoPayment.html @@ -1,8 +1,8 @@ RatyPekaoPayment | react-native-tpay
                                                                                                    react-native-tpay
                                                                                                      Preparing search index...

                                                                                                      Class RatyPekaoPayment

                                                                                                      Class responsible for storing information about Raty Pekao payment

                                                                                                      -

                                                                                                      Hierarchy (View Summary)

                                                                                                      Index

                                                                                                      Constructors

                                                                                                      Hierarchy (View Summary)

                                                                                                      Index

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      callbacks: Callbacks
                                                                                                      channelId: number
                                                                                                      payer: Payer
                                                                                                      paymentDetails: PaymentDetails
                                                                                                      +
                                                                                                    • paymentDetails: PaymentDetails
                                                                                                    • payer: Payer
                                                                                                    • callbacks: Callbacks
                                                                                                    • Returns RatyPekaoPayment

                                                                                                      Properties

                                                                                                      callbacks: Callbacks
                                                                                                      channelId: number
                                                                                                      payer: Payer
                                                                                                      paymentDetails: PaymentDetails
                                                                                                      diff --git a/docs/classes/Recursive.html b/docs/classes/Recursive.html index f76dd72..32b48d0 100644 --- a/docs/classes/Recursive.html +++ b/docs/classes/Recursive.html @@ -1,9 +1,9 @@ Recursive | react-native-tpay
                                                                                                      react-native-tpay
                                                                                                        Preparing search index...

                                                                                                        Class Recursive

                                                                                                        Class responsible for storing information about recurring payments

                                                                                                        -
                                                                                                        Index

                                                                                                        Constructors

                                                                                                        Index

                                                                                                        Constructors

                                                                                                        Properties

                                                                                                        Constructors

                                                                                                        • Parameters

                                                                                                          • frequency: Frequency

                                                                                                            how often payment should be repeated

                                                                                                          • quantity: number | null

                                                                                                            how many times payment should be repeated. If null, quantity = infinity

                                                                                                          • endDate: string

                                                                                                            date in yyyy-MM-dd format

                                                                                                            -

                                                                                                          Returns Recursive

                                                                                                        Properties

                                                                                                        endDate: string
                                                                                                        frequency: Frequency
                                                                                                        quantity: number | null
                                                                                                        +

                                                                                                        Returns Recursive

                                                                                                        Properties

                                                                                                        endDate: string
                                                                                                        frequency: Frequency
                                                                                                        quantity: number | null
                                                                                                        diff --git a/docs/classes/Redirects.html b/docs/classes/Redirects.html index 5855597..5ddf3bc 100644 --- a/docs/classes/Redirects.html +++ b/docs/classes/Redirects.html @@ -1,7 +1,7 @@ Redirects | react-native-tpay
                                                                                                        react-native-tpay
                                                                                                          Preparing search index...

                                                                                                          Class Redirects

                                                                                                          Class responsible for storing information about redirect urls

                                                                                                          -
                                                                                                          Index

                                                                                                          Constructors

                                                                                                          Index

                                                                                                          Constructors

                                                                                                          Properties

                                                                                                          Constructors

                                                                                                          • Parameters

                                                                                                            • successUrl: string

                                                                                                              payer will be redirected to this url after successful payment

                                                                                                            • errorUrl: string

                                                                                                              payer will be redirected to this url after unsuccessful payment

                                                                                                              -

                                                                                                            Returns Redirects

                                                                                                          Properties

                                                                                                          errorUrl: string
                                                                                                          successUrl: string
                                                                                                          +

                                                                                                          Returns Redirects

                                                                                                          Properties

                                                                                                          errorUrl: string
                                                                                                          successUrl: string
                                                                                                          diff --git a/docs/classes/Result.html b/docs/classes/Result.html index 169d519..adc2124 100644 --- a/docs/classes/Result.html +++ b/docs/classes/Result.html @@ -1,11 +1,11 @@ Result | react-native-tpay
                                                                                                          react-native-tpay
                                                                                                            Preparing search index...

                                                                                                            Class ResultAbstract

                                                                                                            Indicates a result of Tpay UI module action

                                                                                                            -

                                                                                                            Hierarchy (View Summary)

                                                                                                            Index

                                                                                                            Constructors

                                                                                                            Hierarchy (View Summary)

                                                                                                            Index

                                                                                                            Constructors

                                                                                                            Properties

                                                                                                            message?: string

                                                                                                            Optional error message or additional information

                                                                                                            -
                                                                                                            paymentUrl?: string

                                                                                                            Payment URL for continuation (used in screenless payments)

                                                                                                            -
                                                                                                            transactionId?: string | null

                                                                                                            Transaction ID when applicable

                                                                                                            -
                                                                                                            type: string

                                                                                                            Type identifier for the result

                                                                                                            -
                                                                                                            +
                                                                                                            paymentUrl?: string

                                                                                                            Payment URL for continuation (used in screenless payments)

                                                                                                            +
                                                                                                            transactionId?: string | null

                                                                                                            Transaction ID when applicable

                                                                                                            +
                                                                                                            type: string

                                                                                                            Type identifier for the result

                                                                                                            +
                                                                                                            diff --git a/docs/classes/ScreenlessBlikAmbiguousAlias.html b/docs/classes/ScreenlessBlikAmbiguousAlias.html index de5d63e..6cb65c8 100644 --- a/docs/classes/ScreenlessBlikAmbiguousAlias.html +++ b/docs/classes/ScreenlessBlikAmbiguousAlias.html @@ -1,17 +1,17 @@ ScreenlessBlikAmbiguousAlias | react-native-tpay
                                                                                                            react-native-tpay
                                                                                                              Preparing search index...

                                                                                                              Class ScreenlessBlikAmbiguousAlias

                                                                                                              Indicates that payer has the same BLIK alias registered in more than one bank app. You need to display a list of aliases to user and then use AmbiguousBlikPayment to continue the payment.

                                                                                                              -

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Constructors

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Constructors

                                                                                                              Properties

                                                                                                              aliases: AmbiguousAlias[]

                                                                                                              Ambiguous aliases that need to be displayed to the user

                                                                                                              -
                                                                                                              error?: string | null

                                                                                                              Error message when applicable

                                                                                                              -
                                                                                                              message?: string

                                                                                                              Optional error message or additional information

                                                                                                              -
                                                                                                              paymentUrl?: string | null

                                                                                                              Payment URL for continuation when applicable

                                                                                                              -
                                                                                                              transactionId: string

                                                                                                              Transaction id of the created transaction

                                                                                                              -
                                                                                                              type: "ambiguousAlias" = 'ambiguousAlias'

                                                                                                              Type identifier for the result

                                                                                                              -
                                                                                                              +

                                                                                                              Constructors

                                                                                                              Properties

                                                                                                              aliases: AmbiguousAlias[]

                                                                                                              Ambiguous aliases that need to be displayed to the user

                                                                                                              +
                                                                                                              error?: string | null

                                                                                                              Error message when applicable

                                                                                                              +
                                                                                                              message?: string

                                                                                                              Optional error message or additional information

                                                                                                              +
                                                                                                              paymentUrl?: string | null

                                                                                                              Payment URL for continuation when applicable

                                                                                                              +
                                                                                                              transactionId: string

                                                                                                              Transaction id of the created transaction

                                                                                                              +
                                                                                                              type: "ambiguousAlias" = 'ambiguousAlias'

                                                                                                              Type identifier for the result

                                                                                                              +
                                                                                                              diff --git a/docs/classes/ScreenlessConfiguredPaymentFailed.html b/docs/classes/ScreenlessConfiguredPaymentFailed.html index 6656715..f93a2c1 100644 --- a/docs/classes/ScreenlessConfiguredPaymentFailed.html +++ b/docs/classes/ScreenlessConfiguredPaymentFailed.html @@ -3,17 +3,17 @@
                                                                                                            • credit card data or credit card token
                                                                                                            • BLIK code or BLIK alias
                                                                                                            • -

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Constructors

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Constructors

                                                                                                              Properties

                                                                                                              aliases?: AmbiguousAlias[]

                                                                                                              Ambiguous aliases for BLIK payments when applicable

                                                                                                              -
                                                                                                              error: string | null

                                                                                                              Optional error message

                                                                                                              -
                                                                                                              message?: string

                                                                                                              Optional error message or additional information

                                                                                                              -
                                                                                                              paymentUrl?: string | null

                                                                                                              Payment URL for continuation when applicable

                                                                                                              -
                                                                                                              transactionId: string

                                                                                                              Transaction id of the created transaction

                                                                                                              -
                                                                                                              type: "configuredPaymentFailed" = 'configuredPaymentFailed'

                                                                                                              Type identifier for the result

                                                                                                              -
                                                                                                              +

                                                                                                              Constructors

                                                                                                              Properties

                                                                                                              aliases?: AmbiguousAlias[]

                                                                                                              Ambiguous aliases for BLIK payments when applicable

                                                                                                              +
                                                                                                              error: string | null

                                                                                                              Optional error message

                                                                                                              +
                                                                                                              message?: string

                                                                                                              Optional error message or additional information

                                                                                                              +
                                                                                                              paymentUrl?: string | null

                                                                                                              Payment URL for continuation when applicable

                                                                                                              +
                                                                                                              transactionId: string

                                                                                                              Transaction id of the created transaction

                                                                                                              +
                                                                                                              type: "configuredPaymentFailed" = 'configuredPaymentFailed'

                                                                                                              Type identifier for the result

                                                                                                              +
                                                                                                              diff --git a/docs/classes/ScreenlessMethodCallError.html b/docs/classes/ScreenlessMethodCallError.html index a271d5d..860092c 100644 --- a/docs/classes/ScreenlessMethodCallError.html +++ b/docs/classes/ScreenlessMethodCallError.html @@ -1,15 +1,15 @@ ScreenlessMethodCallError | react-native-tpay
                                                                                                              react-native-tpay
                                                                                                                Preparing search index...

                                                                                                                Class ScreenlessMethodCallError

                                                                                                                Indicates a module error

                                                                                                                -

                                                                                                                Hierarchy (View Summary)

                                                                                                                Index

                                                                                                                Constructors

                                                                                                                Hierarchy (View Summary)

                                                                                                                Index

                                                                                                                Constructors

                                                                                                                Properties

                                                                                                                aliases?: AmbiguousAlias[]

                                                                                                                Ambiguous aliases for BLIK payments when applicable

                                                                                                                -
                                                                                                                error?: string | null

                                                                                                                Error message when applicable

                                                                                                                -
                                                                                                                message: string

                                                                                                                Error message

                                                                                                                -
                                                                                                                paymentUrl?: string | null

                                                                                                                Payment URL for continuation when applicable

                                                                                                                -
                                                                                                                transactionId?: string

                                                                                                                Transaction ID when applicable

                                                                                                                -
                                                                                                                type: "methodCallError" = 'methodCallError'

                                                                                                                Type identifier for the result

                                                                                                                -
                                                                                                                +

                                                                                                                Constructors

                                                                                                                Properties

                                                                                                                aliases?: AmbiguousAlias[]

                                                                                                                Ambiguous aliases for BLIK payments when applicable

                                                                                                                +
                                                                                                                error?: string | null

                                                                                                                Error message when applicable

                                                                                                                +
                                                                                                                message: string

                                                                                                                Error message

                                                                                                                +
                                                                                                                paymentUrl?: string | null

                                                                                                                Payment URL for continuation when applicable

                                                                                                                +
                                                                                                                transactionId?: string

                                                                                                                Transaction ID when applicable

                                                                                                                +
                                                                                                                type: "methodCallError" = 'methodCallError'

                                                                                                                Type identifier for the result

                                                                                                                +
                                                                                                                diff --git a/docs/classes/ScreenlessPaid.html b/docs/classes/ScreenlessPaid.html index fcef887..2fd6604 100644 --- a/docs/classes/ScreenlessPaid.html +++ b/docs/classes/ScreenlessPaid.html @@ -1,15 +1,15 @@ ScreenlessPaid | react-native-tpay
                                                                                                                react-native-tpay
                                                                                                                  Preparing search index...

                                                                                                                  Class ScreenlessPaid

                                                                                                                  Indicates that payment was completed successfully

                                                                                                                  -

                                                                                                                  Hierarchy (View Summary)

                                                                                                                  Index

                                                                                                                  Constructors

                                                                                                                  Hierarchy (View Summary)

                                                                                                                  Index

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  aliases?: AmbiguousAlias[]

                                                                                                                  Ambiguous aliases for BLIK payments when applicable

                                                                                                                  -
                                                                                                                  error?: string | null

                                                                                                                  Error message when applicable

                                                                                                                  -
                                                                                                                  message?: string

                                                                                                                  Optional error message or additional information

                                                                                                                  -
                                                                                                                  paymentUrl?: string | null

                                                                                                                  Payment URL for continuation when applicable

                                                                                                                  -
                                                                                                                  transactionId: string

                                                                                                                  Transaction id of the completed transaction

                                                                                                                  -
                                                                                                                  type: "paid" = 'paid'

                                                                                                                  Type identifier for the result

                                                                                                                  -
                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  aliases?: AmbiguousAlias[]

                                                                                                                  Ambiguous aliases for BLIK payments when applicable

                                                                                                                  +
                                                                                                                  error?: string | null

                                                                                                                  Error message when applicable

                                                                                                                  +
                                                                                                                  message?: string

                                                                                                                  Optional error message or additional information

                                                                                                                  +
                                                                                                                  paymentUrl?: string | null

                                                                                                                  Payment URL for continuation when applicable

                                                                                                                  +
                                                                                                                  transactionId: string

                                                                                                                  Transaction id of the completed transaction

                                                                                                                  +
                                                                                                                  type: "paid" = 'paid'

                                                                                                                  Type identifier for the result

                                                                                                                  +
                                                                                                                  diff --git a/docs/classes/ScreenlessPayment.html b/docs/classes/ScreenlessPayment.html index abb02b2..4d4b01d 100644 --- a/docs/classes/ScreenlessPayment.html +++ b/docs/classes/ScreenlessPayment.html @@ -1,9 +1,9 @@ ScreenlessPayment | react-native-tpay
                                                                                                                  react-native-tpay
                                                                                                                    Preparing search index...

                                                                                                                    Class ScreenlessPayment

                                                                                                                    Class responsible for storing information about screenless payment details

                                                                                                                    -

                                                                                                                    Hierarchy (View Summary)

                                                                                                                    Index

                                                                                                                    Constructors

                                                                                                                    Hierarchy (View Summary)

                                                                                                                    Index

                                                                                                                    Constructors

                                                                                                                    Properties

                                                                                                                    Constructors

                                                                                                                    Properties

                                                                                                                    callbacks: Callbacks
                                                                                                                    payer: Payer
                                                                                                                    paymentDetails: PaymentDetails
                                                                                                                    +

                                                                                                                    Returns ScreenlessPayment

                                                                                                                    Properties

                                                                                                                    callbacks: Callbacks
                                                                                                                    payer: Payer
                                                                                                                    paymentDetails: PaymentDetails
                                                                                                                    diff --git a/docs/classes/ScreenlessPaymentCreated.html b/docs/classes/ScreenlessPaymentCreated.html index 32c1fdb..7dbae3f 100644 --- a/docs/classes/ScreenlessPaymentCreated.html +++ b/docs/classes/ScreenlessPaymentCreated.html @@ -4,17 +4,17 @@ If it was a BLIK payment user has to accept it in bank app. It is advised to use long polling mechanism to observe payment status via transactionId.

                                                                                                                    -

                                                                                                                    Hierarchy (View Summary)

                                                                                                                    Index

                                                                                                                    Constructors

                                                                                                                    Hierarchy (View Summary)

                                                                                                                    Index

                                                                                                                    Constructors

                                                                                                                    Properties

                                                                                                                    aliases?: AmbiguousAlias[]

                                                                                                                    Ambiguous aliases for BLIK payments when applicable

                                                                                                                    -
                                                                                                                    error?: string | null

                                                                                                                    Error message when applicable

                                                                                                                    -
                                                                                                                    message?: string

                                                                                                                    Optional error message or additional information

                                                                                                                    -
                                                                                                                    paymentUrl: string | null

                                                                                                                    Payment url, needs to be displayed to the user to finish the payment

                                                                                                                    -
                                                                                                                    transactionId: string

                                                                                                                    Transaction id of the created transaction

                                                                                                                    -
                                                                                                                    type: "paymentCreated" = 'paymentCreated'

                                                                                                                    Type identifier for the result

                                                                                                                    -
                                                                                                                    +

                                                                                                                    Constructors

                                                                                                                    Properties

                                                                                                                    aliases?: AmbiguousAlias[]

                                                                                                                    Ambiguous aliases for BLIK payments when applicable

                                                                                                                    +
                                                                                                                    error?: string | null

                                                                                                                    Error message when applicable

                                                                                                                    +
                                                                                                                    message?: string

                                                                                                                    Optional error message or additional information

                                                                                                                    +
                                                                                                                    paymentUrl: string | null

                                                                                                                    Payment url, needs to be displayed to the user to finish the payment

                                                                                                                    +
                                                                                                                    transactionId: string

                                                                                                                    Transaction id of the created transaction

                                                                                                                    +
                                                                                                                    type: "paymentCreated" = 'paymentCreated'

                                                                                                                    Type identifier for the result

                                                                                                                    +
                                                                                                                    diff --git a/docs/classes/ScreenlessPaymentError.html b/docs/classes/ScreenlessPaymentError.html index bfbd9b5..6d8499c 100644 --- a/docs/classes/ScreenlessPaymentError.html +++ b/docs/classes/ScreenlessPaymentError.html @@ -1,15 +1,15 @@ ScreenlessPaymentError | react-native-tpay
                                                                                                                    react-native-tpay
                                                                                                                      Preparing search index...

                                                                                                                      Class ScreenlessPaymentError

                                                                                                                      Indicates that payment was not created because of an error

                                                                                                                      -

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Constructors

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Constructors

                                                                                                                      Properties

                                                                                                                      aliases?: AmbiguousAlias[]

                                                                                                                      Ambiguous aliases for BLIK payments when applicable

                                                                                                                      -
                                                                                                                      error: string | null

                                                                                                                      Optional error message

                                                                                                                      -
                                                                                                                      message?: string

                                                                                                                      Optional error message or additional information

                                                                                                                      -
                                                                                                                      paymentUrl?: string | null

                                                                                                                      Payment URL for continuation when applicable

                                                                                                                      -
                                                                                                                      transactionId?: string

                                                                                                                      Transaction ID when applicable

                                                                                                                      -
                                                                                                                      type: "error" = 'error'

                                                                                                                      Type identifier for the result

                                                                                                                      -
                                                                                                                      +

                                                                                                                      Constructors

                                                                                                                      Properties

                                                                                                                      aliases?: AmbiguousAlias[]

                                                                                                                      Ambiguous aliases for BLIK payments when applicable

                                                                                                                      +
                                                                                                                      error: string | null

                                                                                                                      Optional error message

                                                                                                                      +
                                                                                                                      message?: string

                                                                                                                      Optional error message or additional information

                                                                                                                      +
                                                                                                                      paymentUrl?: string | null

                                                                                                                      Payment URL for continuation when applicable

                                                                                                                      +
                                                                                                                      transactionId?: string

                                                                                                                      Transaction ID when applicable

                                                                                                                      +
                                                                                                                      type: "error" = 'error'

                                                                                                                      Type identifier for the result

                                                                                                                      +
                                                                                                                      diff --git a/docs/classes/ScreenlessResult.html b/docs/classes/ScreenlessResult.html index b0ee514..56ec348 100644 --- a/docs/classes/ScreenlessResult.html +++ b/docs/classes/ScreenlessResult.html @@ -1,5 +1,5 @@ ScreenlessResult | react-native-tpay
                                                                                                                      react-native-tpay
                                                                                                                        Preparing search index...

                                                                                                                        Class ScreenlessResultAbstract

                                                                                                                        Indicates a result of screenless action

                                                                                                                        -

                                                                                                                        Hierarchy (View Summary)

                                                                                                                        Index

                                                                                                                        Constructors

                                                                                                                        Hierarchy (View Summary)

                                                                                                                        Index

                                                                                                                        Constructors

                                                                                                                        Properties

                                                                                                                        Constructors

                                                                                                                        Properties

                                                                                                                        aliases?: AmbiguousAlias[]

                                                                                                                        Ambiguous aliases for BLIK payments when applicable

                                                                                                                        -
                                                                                                                        error?: string | null

                                                                                                                        Error message when applicable

                                                                                                                        -
                                                                                                                        message?: string

                                                                                                                        Optional error message or additional information

                                                                                                                        -
                                                                                                                        paymentUrl?: string | null

                                                                                                                        Payment URL for continuation when applicable

                                                                                                                        -
                                                                                                                        transactionId?: string

                                                                                                                        Transaction ID when applicable

                                                                                                                        -
                                                                                                                        type: string

                                                                                                                        Type identifier for the result

                                                                                                                        -
                                                                                                                        +
                                                                                                                        error?: string | null

                                                                                                                        Error message when applicable

                                                                                                                        +
                                                                                                                        message?: string

                                                                                                                        Optional error message or additional information

                                                                                                                        +
                                                                                                                        paymentUrl?: string | null

                                                                                                                        Payment URL for continuation when applicable

                                                                                                                        +
                                                                                                                        transactionId?: string

                                                                                                                        Transaction ID when applicable

                                                                                                                        +
                                                                                                                        type: string

                                                                                                                        Type identifier for the result

                                                                                                                        +
                                                                                                                        diff --git a/docs/classes/ScreenlessValidationError.html b/docs/classes/ScreenlessValidationError.html index 3964ad4..2f9f885 100644 --- a/docs/classes/ScreenlessValidationError.html +++ b/docs/classes/ScreenlessValidationError.html @@ -1,15 +1,15 @@ ScreenlessValidationError | react-native-tpay
                                                                                                                        react-native-tpay
                                                                                                                          Preparing search index...

                                                                                                                          Class ScreenlessValidationError

                                                                                                                          Indicates that some data passed to payment is invalid

                                                                                                                          -

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          Index

                                                                                                                          Constructors

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          Index

                                                                                                                          Constructors

                                                                                                                          Properties

                                                                                                                          aliases?: AmbiguousAlias[]

                                                                                                                          Ambiguous aliases for BLIK payments when applicable

                                                                                                                          -
                                                                                                                          error?: string | null

                                                                                                                          Error message when applicable

                                                                                                                          -
                                                                                                                          message: string

                                                                                                                          Validation error message

                                                                                                                          -
                                                                                                                          paymentUrl?: string | null

                                                                                                                          Payment URL for continuation when applicable

                                                                                                                          -
                                                                                                                          transactionId?: string

                                                                                                                          Transaction ID when applicable

                                                                                                                          -
                                                                                                                          type: "validationError" = 'validationError'

                                                                                                                          Type identifier for the result

                                                                                                                          -
                                                                                                                          +

                                                                                                                          Constructors

                                                                                                                          Properties

                                                                                                                          aliases?: AmbiguousAlias[]

                                                                                                                          Ambiguous aliases for BLIK payments when applicable

                                                                                                                          +
                                                                                                                          error?: string | null

                                                                                                                          Error message when applicable

                                                                                                                          +
                                                                                                                          message: string

                                                                                                                          Validation error message

                                                                                                                          +
                                                                                                                          paymentUrl?: string | null

                                                                                                                          Payment URL for continuation when applicable

                                                                                                                          +
                                                                                                                          transactionId?: string

                                                                                                                          Transaction ID when applicable

                                                                                                                          +
                                                                                                                          type: "validationError" = 'validationError'

                                                                                                                          Type identifier for the result

                                                                                                                          +
                                                                                                                          diff --git a/docs/classes/SingleTransaction.html b/docs/classes/SingleTransaction.html index 0382304..cb35d7a 100644 --- a/docs/classes/SingleTransaction.html +++ b/docs/classes/SingleTransaction.html @@ -1,5 +1,5 @@ SingleTransaction | react-native-tpay
                                                                                                                          react-native-tpay
                                                                                                                            Preparing search index...

                                                                                                                            Class SingleTransaction

                                                                                                                            Class responsible for storing information about standard Tpay UI module payment

                                                                                                                            -

                                                                                                                            Hierarchy (View Summary)

                                                                                                                            Index

                                                                                                                            Constructors

                                                                                                                            Hierarchy (View Summary)

                                                                                                                            Index

                                                                                                                            Constructors

                                                                                                                            Properties

                                                                                                                          • description: string

                                                                                                                            description of payment shown to payer

                                                                                                                          • hiddenDescription: string | null

                                                                                                                            description of payment shown to merchant

                                                                                                                          • notifications: Notifications | null

                                                                                                                            payment notification url and email

                                                                                                                            -
                                                                                                                          • Returns SingleTransaction

                                                                                                                            Properties

                                                                                                                            amount: number
                                                                                                                            description: string
                                                                                                                            hiddenDescription: string | null
                                                                                                                            notifications: Notifications | null
                                                                                                                            payerContext: PayerContext
                                                                                                                            +

                                                                                                                            Returns SingleTransaction

                                                                                                                            Properties

                                                                                                                            amount: number
                                                                                                                            description: string
                                                                                                                            hiddenDescription: string | null
                                                                                                                            notifications: Notifications | null
                                                                                                                            payerContext: PayerContext
                                                                                                                            diff --git a/docs/classes/TokenPayment.html b/docs/classes/TokenPayment.html index 0d077a5..5cafa08 100644 --- a/docs/classes/TokenPayment.html +++ b/docs/classes/TokenPayment.html @@ -1,5 +1,5 @@ TokenPayment | react-native-tpay
                                                                                                                            react-native-tpay
                                                                                                                              Preparing search index...

                                                                                                                              Class TokenPayment

                                                                                                                              Class responsible for storing information about credit card token payment with Tpay UI module.

                                                                                                                              -

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              Index

                                                                                                                              Constructors

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              Index

                                                                                                                              Constructors

                                                                                                                              Properties

                                                                                                                              amount cardToken description @@ -12,4 +12,4 @@
                                                                                                                            • description: string

                                                                                                                              description of payment shown to payer

                                                                                                                            • hiddenDescription: string | null

                                                                                                                              description of payment shown to merchant

                                                                                                                            • notifications: Notifications | null

                                                                                                                              payment notification url and email

                                                                                                                              -
                                                                                                                            • Returns TokenPayment

                                                                                                                              Properties

                                                                                                                              amount: number
                                                                                                                              cardToken: string
                                                                                                                              description: string
                                                                                                                              hiddenDescription: string | null
                                                                                                                              notifications: Notifications | null
                                                                                                                              payer: Payer
                                                                                                                              +

                                                                                                                              Returns TokenPayment

                                                                                                                              Properties

                                                                                                                              amount: number
                                                                                                                              cardToken: string
                                                                                                                              description: string
                                                                                                                              hiddenDescription: string | null
                                                                                                                              notifications: Notifications | null
                                                                                                                              payer: Payer
                                                                                                                              diff --git a/docs/classes/Tokenization.html b/docs/classes/Tokenization.html index f008d04..150f40e 100644 --- a/docs/classes/Tokenization.html +++ b/docs/classes/Tokenization.html @@ -1,7 +1,7 @@ Tokenization | react-native-tpay
                                                                                                                              react-native-tpay
                                                                                                                                Preparing search index...

                                                                                                                                Class Tokenization

                                                                                                                                Class responsible for storing information needed to start UI tokenization.

                                                                                                                                -
                                                                                                                                Index

                                                                                                                                Constructors

                                                                                                                                Index

                                                                                                                                Constructors

                                                                                                                                Properties

                                                                                                                                Constructors

                                                                                                                                Properties

                                                                                                                                notificationUrl: string
                                                                                                                                payer: Payer
                                                                                                                                +

                                                                                                                                Returns Tokenization

                                                                                                                                Properties

                                                                                                                                notificationUrl: string
                                                                                                                                payer: Payer
                                                                                                                                diff --git a/docs/classes/TokenizationCompleted.html b/docs/classes/TokenizationCompleted.html index e8d3e4b..7070934 100644 --- a/docs/classes/TokenizationCompleted.html +++ b/docs/classes/TokenizationCompleted.html @@ -1,11 +1,11 @@ TokenizationCompleted | react-native-tpay
                                                                                                                                react-native-tpay
                                                                                                                                  Preparing search index...

                                                                                                                                  Class TokenizationCompleted

                                                                                                                                  Indicates that credit card tokenization was successful and module was closed

                                                                                                                                  -

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  Index

                                                                                                                                  Constructors

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  Index

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  message?: string

                                                                                                                                  Optional error message or additional information

                                                                                                                                  -
                                                                                                                                  paymentUrl?: string

                                                                                                                                  Payment URL for continuation (used in screenless payments)

                                                                                                                                  -
                                                                                                                                  transactionId?: string | null

                                                                                                                                  Transaction ID when applicable

                                                                                                                                  -
                                                                                                                                  type: "tokenizationCompleted" = 'tokenizationCompleted'

                                                                                                                                  Type identifier for the result

                                                                                                                                  -
                                                                                                                                  +
                                                                                                                                  paymentUrl?: string

                                                                                                                                  Payment URL for continuation (used in screenless payments)

                                                                                                                                  +
                                                                                                                                  transactionId?: string | null

                                                                                                                                  Transaction ID when applicable

                                                                                                                                  +
                                                                                                                                  type: "tokenizationCompleted" = 'tokenizationCompleted'

                                                                                                                                  Type identifier for the result

                                                                                                                                  +
                                                                                                                                  diff --git a/docs/classes/TokenizationFailure.html b/docs/classes/TokenizationFailure.html index efb0651..75657cd 100644 --- a/docs/classes/TokenizationFailure.html +++ b/docs/classes/TokenizationFailure.html @@ -1,11 +1,11 @@ TokenizationFailure | react-native-tpay
                                                                                                                                  react-native-tpay
                                                                                                                                    Preparing search index...

                                                                                                                                    Class TokenizationFailure

                                                                                                                                    Indicates that credit card tokenization failed and module was closed

                                                                                                                                    -

                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                    Index

                                                                                                                                    Constructors

                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                    Index

                                                                                                                                    Constructors

                                                                                                                                    Properties

                                                                                                                                    message?: string

                                                                                                                                    Optional error message or additional information

                                                                                                                                    -
                                                                                                                                    paymentUrl?: string

                                                                                                                                    Payment URL for continuation (used in screenless payments)

                                                                                                                                    -
                                                                                                                                    transactionId?: string | null

                                                                                                                                    Transaction ID when applicable

                                                                                                                                    -
                                                                                                                                    type: "tokenizationFailure" = 'tokenizationFailure'

                                                                                                                                    Type identifier for the result

                                                                                                                                    -
                                                                                                                                    +
                                                                                                                                    paymentUrl?: string

                                                                                                                                    Payment URL for continuation (used in screenless payments)

                                                                                                                                    +
                                                                                                                                    transactionId?: string | null

                                                                                                                                    Transaction ID when applicable

                                                                                                                                    +
                                                                                                                                    type: "tokenizationFailure" = 'tokenizationFailure'

                                                                                                                                    Type identifier for the result

                                                                                                                                    +
                                                                                                                                    diff --git a/docs/classes/TokenizedCard.html b/docs/classes/TokenizedCard.html index f22c87f..a7cb713 100644 --- a/docs/classes/TokenizedCard.html +++ b/docs/classes/TokenizedCard.html @@ -1,9 +1,9 @@ TokenizedCard | react-native-tpay
                                                                                                                                    react-native-tpay
                                                                                                                                      Preparing search index...

                                                                                                                                      Class TokenizedCard

                                                                                                                                      Class responsible for storing tokenized card information

                                                                                                                                      -
                                                                                                                                      Index

                                                                                                                                      Constructors

                                                                                                                                      Index

                                                                                                                                      Constructors

                                                                                                                                      Properties

                                                                                                                                      Constructors

                                                                                                                                      Properties

                                                                                                                                      cardTail: string
                                                                                                                                      token: string
                                                                                                                                      +

                                                                                                                                      Returns TokenizedCard

                                                                                                                                      Properties

                                                                                                                                      cardTail: string
                                                                                                                                      token: string
                                                                                                                                      diff --git a/docs/classes/TpayConfiguration.html b/docs/classes/TpayConfiguration.html index f5b1694..0e47690 100644 --- a/docs/classes/TpayConfiguration.html +++ b/docs/classes/TpayConfiguration.html @@ -1,5 +1,5 @@ TpayConfiguration | react-native-tpay
                                                                                                                                      react-native-tpay
                                                                                                                                        Preparing search index...

                                                                                                                                        Class TpayConfiguration

                                                                                                                                        Class responsible for storing information about Tpay configuration

                                                                                                                                        -
                                                                                                                                        Index

                                                                                                                                        Constructors

                                                                                                                                        Index

                                                                                                                                        Constructors

                                                                                                                                        Properties

                                                                                                                                      • merchantDetails: MerchantDetails

                                                                                                                                        information about merchant in different languages

                                                                                                                                      • languages: Languages

                                                                                                                                        languages that user will be able to use in Tpay UI module

                                                                                                                                      • paymentMethods: PaymentMethods

                                                                                                                                        payment methods that user will be able to use in Tpay UI module

                                                                                                                                        -
                                                                                                                                      • Returns TpayConfiguration

                                                                                                                                        Properties

                                                                                                                                        languages: Languages
                                                                                                                                        merchant: Merchant
                                                                                                                                        merchantDetails: MerchantDetails
                                                                                                                                        paymentMethods: PaymentMethods
                                                                                                                                        +

                                                                                                                                        Returns TpayConfiguration

                                                                                                                                        Properties

                                                                                                                                        languages: Languages
                                                                                                                                        merchant: Merchant
                                                                                                                                        merchantDetails: MerchantDetails
                                                                                                                                        paymentMethods: PaymentMethods
                                                                                                                                        diff --git a/docs/classes/Transaction.html b/docs/classes/Transaction.html index 39af9fb..a6b6358 100644 --- a/docs/classes/Transaction.html +++ b/docs/classes/Transaction.html @@ -1,5 +1,5 @@ Transaction | react-native-tpay
                                                                                                                                        react-native-tpay
                                                                                                                                          Preparing search index...

                                                                                                                                          Class Transaction

                                                                                                                                          Class responsible for storing information about UI module transaction

                                                                                                                                          -

                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          Properties

                                                                                                                                        • description: string

                                                                                                                                          description of payment shown to payer

                                                                                                                                        • hiddenDescription: string | null

                                                                                                                                          description of payment shown to merchant

                                                                                                                                        • notifications: Notifications | null

                                                                                                                                          payment notification url and email

                                                                                                                                          -
                                                                                                                                        • Returns Transaction

                                                                                                                                          Properties

                                                                                                                                          amount: number
                                                                                                                                          description: string
                                                                                                                                          hiddenDescription: string | null
                                                                                                                                          notifications: Notifications | null
                                                                                                                                          +

                                                                                                                                          Returns Transaction

                                                                                                                                          Properties

                                                                                                                                          amount: number
                                                                                                                                          description: string
                                                                                                                                          hiddenDescription: string | null
                                                                                                                                          notifications: Notifications | null
                                                                                                                                          diff --git a/docs/classes/TransferPayment.html b/docs/classes/TransferPayment.html index 4564300..34cb8e5 100644 --- a/docs/classes/TransferPayment.html +++ b/docs/classes/TransferPayment.html @@ -1,8 +1,8 @@ TransferPayment | react-native-tpay
                                                                                                                                          react-native-tpay
                                                                                                                                            Preparing search index...

                                                                                                                                            Class TransferPayment

                                                                                                                                            Class responsible for storing information about transfer payment

                                                                                                                                            -

                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                            Index

                                                                                                                                            Constructors

                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                            Index

                                                                                                                                            Constructors

                                                                                                                                            Properties

                                                                                                                                            callbacks: Callbacks
                                                                                                                                            channelId: number
                                                                                                                                            payer: Payer
                                                                                                                                            paymentDetails: PaymentDetails
                                                                                                                                            +
                                                                                                                                          • paymentDetails: PaymentDetails
                                                                                                                                          • payer: Payer
                                                                                                                                          • callbacks: Callbacks
                                                                                                                                          • Returns TransferPayment

                                                                                                                                            Properties

                                                                                                                                            callbacks: Callbacks
                                                                                                                                            channelId: number
                                                                                                                                            payer: Payer
                                                                                                                                            paymentDetails: PaymentDetails
                                                                                                                                            diff --git a/docs/classes/ValidationError.html b/docs/classes/ValidationError.html index a5e7b57..38730f3 100644 --- a/docs/classes/ValidationError.html +++ b/docs/classes/ValidationError.html @@ -1,11 +1,11 @@ ValidationError | react-native-tpay
                                                                                                                                            react-native-tpay
                                                                                                                                              Preparing search index...

                                                                                                                                              Class ValidationError

                                                                                                                                              Indicates that some data passed to module is invalid

                                                                                                                                              -

                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                              Index

                                                                                                                                              Constructors

                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                              Index

                                                                                                                                              Constructors

                                                                                                                                              Properties

                                                                                                                                              message: string

                                                                                                                                              Validation error message

                                                                                                                                              -
                                                                                                                                              paymentUrl?: string

                                                                                                                                              Payment URL for continuation (used in screenless payments)

                                                                                                                                              -
                                                                                                                                              transactionId?: string | null

                                                                                                                                              Transaction ID when applicable

                                                                                                                                              -
                                                                                                                                              type: "validationError" = 'validationError'

                                                                                                                                              Type identifier for the result

                                                                                                                                              -
                                                                                                                                              +

                                                                                                                                              Constructors

                                                                                                                                              Properties

                                                                                                                                              message: string

                                                                                                                                              Validation error message

                                                                                                                                              +
                                                                                                                                              paymentUrl?: string

                                                                                                                                              Payment URL for continuation (used in screenless payments)

                                                                                                                                              +
                                                                                                                                              transactionId?: string | null

                                                                                                                                              Transaction ID when applicable

                                                                                                                                              +
                                                                                                                                              type: "validationError" = 'validationError'

                                                                                                                                              Type identifier for the result

                                                                                                                                              +
                                                                                                                                              diff --git a/docs/classes/WalletConfiguration.html b/docs/classes/WalletConfiguration.html index 3d1bd61..279eabe 100644 --- a/docs/classes/WalletConfiguration.html +++ b/docs/classes/WalletConfiguration.html @@ -1,7 +1,7 @@ WalletConfiguration | react-native-tpay
                                                                                                                                              react-native-tpay
                                                                                                                                                Preparing search index...

                                                                                                                                                Class WalletConfiguration

                                                                                                                                                Class responsible for storing wallet configuration

                                                                                                                                                -
                                                                                                                                                Index

                                                                                                                                                Constructors

                                                                                                                                                Index

                                                                                                                                                Constructors

                                                                                                                                                Properties

                                                                                                                                                Constructors

                                                                                                                                                Properties

                                                                                                                                                applePay: ApplePayConfiguration | null
                                                                                                                                                googlePay: GooglePayConfiguration | null
                                                                                                                                                +

                                                                                                                                                Returns WalletConfiguration

                                                                                                                                                Properties

                                                                                                                                                applePay: ApplePayConfiguration | null
                                                                                                                                                googlePay: GooglePayConfiguration | null
                                                                                                                                                diff --git a/docs/enums/CreditCardBrand.html b/docs/enums/CreditCardBrand.html index 7fd287e..d4fadb3 100644 --- a/docs/enums/CreditCardBrand.html +++ b/docs/enums/CreditCardBrand.html @@ -1,5 +1,5 @@ CreditCardBrand | react-native-tpay
                                                                                                                                                react-native-tpay
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Enumeration CreditCardBrand

                                                                                                                                                  Enum describing possible credit card brands

                                                                                                                                                  -
                                                                                                                                                  Index

                                                                                                                                                  Enumeration Members

                                                                                                                                                  Index

                                                                                                                                                  Enumeration Members

                                                                                                                                                  Enumeration Members

                                                                                                                                                  mastercard: "mastercard"
                                                                                                                                                  unknown: "unknown"
                                                                                                                                                  visa: "visa"
                                                                                                                                                  +

                                                                                                                                                  Enumeration Members

                                                                                                                                                  mastercard: "mastercard"
                                                                                                                                                  unknown: "unknown"
                                                                                                                                                  visa: "visa"
                                                                                                                                                  diff --git a/docs/enums/DigitalWallet.html b/docs/enums/DigitalWallet.html index 6a06c62..dbcf3be 100644 --- a/docs/enums/DigitalWallet.html +++ b/docs/enums/DigitalWallet.html @@ -1,4 +1,4 @@ DigitalWallet | react-native-tpay
                                                                                                                                                  react-native-tpay
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Enumeration DigitalWallet

                                                                                                                                                    Enum describing possible digital wallets

                                                                                                                                                    -
                                                                                                                                                    Index

                                                                                                                                                    Enumeration Members

                                                                                                                                                    Index

                                                                                                                                                    Enumeration Members

                                                                                                                                                    Enumeration Members

                                                                                                                                                    applePay: "applePay"
                                                                                                                                                    googlePay: "googlePay"
                                                                                                                                                    +

                                                                                                                                                    Enumeration Members

                                                                                                                                                    applePay: "applePay"
                                                                                                                                                    googlePay: "googlePay"
                                                                                                                                                    diff --git a/docs/enums/Frequency.html b/docs/enums/Frequency.html index f9b61fc..0672c42 100644 --- a/docs/enums/Frequency.html +++ b/docs/enums/Frequency.html @@ -1,7 +1,7 @@ Frequency | react-native-tpay
                                                                                                                                                    react-native-tpay
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Enumeration Frequency

                                                                                                                                                      Enum describing the frequency options

                                                                                                                                                      -
                                                                                                                                                      Index

                                                                                                                                                      Enumeration Members

                                                                                                                                                      Index

                                                                                                                                                      Enumeration Members

                                                                                                                                                      Enumeration Members

                                                                                                                                                      daily: "daily"
                                                                                                                                                      monthly: "monthly"
                                                                                                                                                      quarterly: "quarterly"
                                                                                                                                                      weekly: "weekly"
                                                                                                                                                      yearly: "yearly"
                                                                                                                                                      +

                                                                                                                                                      Enumeration Members

                                                                                                                                                      daily: "daily"
                                                                                                                                                      monthly: "monthly"
                                                                                                                                                      quarterly: "quarterly"
                                                                                                                                                      weekly: "weekly"
                                                                                                                                                      yearly: "yearly"
                                                                                                                                                      diff --git a/docs/enums/GooglePayEnvironment.html b/docs/enums/GooglePayEnvironment.html index fd3cefd..f203516 100644 --- a/docs/enums/GooglePayEnvironment.html +++ b/docs/enums/GooglePayEnvironment.html @@ -1,4 +1,4 @@ GooglePayEnvironment | react-native-tpay
                                                                                                                                                      react-native-tpay
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Enumeration GooglePayEnvironment

                                                                                                                                                        Enum describing Google Pay environment options

                                                                                                                                                        -
                                                                                                                                                        Index

                                                                                                                                                        Enumeration Members

                                                                                                                                                        Index

                                                                                                                                                        Enumeration Members

                                                                                                                                                        Enumeration Members

                                                                                                                                                        production: "production"
                                                                                                                                                        test: "test"
                                                                                                                                                        +

                                                                                                                                                        Enumeration Members

                                                                                                                                                        production: "production"
                                                                                                                                                        test: "test"
                                                                                                                                                        diff --git a/docs/enums/InstallmentPayment.html b/docs/enums/InstallmentPayment.html index a299e45..fee6070 100644 --- a/docs/enums/InstallmentPayment.html +++ b/docs/enums/InstallmentPayment.html @@ -1,4 +1,4 @@ InstallmentPayment | react-native-tpay
                                                                                                                                                        react-native-tpay
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Enumeration InstallmentPayment

                                                                                                                                                          Enum describing possible installment payments

                                                                                                                                                          -
                                                                                                                                                          Index

                                                                                                                                                          Enumeration Members

                                                                                                                                                          Index

                                                                                                                                                          Enumeration Members

                                                                                                                                                          Enumeration Members

                                                                                                                                                          payPo: "payPo"
                                                                                                                                                          ratyPekao: "ratyPekao"
                                                                                                                                                          +

                                                                                                                                                          Enumeration Members

                                                                                                                                                          payPo: "payPo"
                                                                                                                                                          ratyPekao: "ratyPekao"
                                                                                                                                                          diff --git a/docs/enums/Language.html b/docs/enums/Language.html index fb87f6b..9592ae5 100644 --- a/docs/enums/Language.html +++ b/docs/enums/Language.html @@ -1,3 +1,3 @@ -Language | react-native-tpay
                                                                                                                                                          react-native-tpay
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Enumeration Language

                                                                                                                                                            Index

                                                                                                                                                            Enumeration Members

                                                                                                                                                            en +Language | react-native-tpay
                                                                                                                                                            react-native-tpay
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Enumeration Language

                                                                                                                                                              Index

                                                                                                                                                              Enumeration Members

                                                                                                                                                              en pl -

                                                                                                                                                              Enumeration Members

                                                                                                                                                              en: "en"
                                                                                                                                                              pl: "pl"
                                                                                                                                                              +

                                                                                                                                                              Enumeration Members

                                                                                                                                                              en: "en"
                                                                                                                                                              pl: "pl"
                                                                                                                                                              diff --git a/docs/enums/PaymentConstraintType.html b/docs/enums/PaymentConstraintType.html index f554e1b..65e3524 100644 --- a/docs/enums/PaymentConstraintType.html +++ b/docs/enums/PaymentConstraintType.html @@ -1,3 +1,3 @@ PaymentConstraintType | react-native-tpay
                                                                                                                                                              react-native-tpay
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Enumeration PaymentConstraintType

                                                                                                                                                                Enum describing available payment constraint types

                                                                                                                                                                -
                                                                                                                                                                Index

                                                                                                                                                                Enumeration Members

                                                                                                                                                                Enumeration Members

                                                                                                                                                                amount: "amount"
                                                                                                                                                                +
                                                                                                                                                                Index

                                                                                                                                                                Enumeration Members

                                                                                                                                                                Enumeration Members

                                                                                                                                                                amount: "amount"
                                                                                                                                                                diff --git a/docs/enums/PaymentMethod.html b/docs/enums/PaymentMethod.html index ea5a1c6..b36143b 100644 --- a/docs/enums/PaymentMethod.html +++ b/docs/enums/PaymentMethod.html @@ -1,5 +1,5 @@ PaymentMethod | react-native-tpay
                                                                                                                                                                react-native-tpay
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Enumeration PaymentMethod

                                                                                                                                                                  Enum describing possible payment methods

                                                                                                                                                                  -
                                                                                                                                                                  Index

                                                                                                                                                                  Enumeration Members

                                                                                                                                                                  Index

                                                                                                                                                                  Enumeration Members

                                                                                                                                                                  Enumeration Members

                                                                                                                                                                  blik: "blik"
                                                                                                                                                                  card: "card"
                                                                                                                                                                  transfer: "transfer"
                                                                                                                                                                  +

                                                                                                                                                                  Enumeration Members

                                                                                                                                                                  blik: "blik"
                                                                                                                                                                  card: "card"
                                                                                                                                                                  transfer: "transfer"
                                                                                                                                                                  diff --git a/docs/enums/TpayEnvironment.html b/docs/enums/TpayEnvironment.html index 7da7d6d..7faf4bd 100644 --- a/docs/enums/TpayEnvironment.html +++ b/docs/enums/TpayEnvironment.html @@ -1,3 +1,3 @@ -TpayEnvironment | react-native-tpay
                                                                                                                                                                  react-native-tpay
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Enumeration TpayEnvironment

                                                                                                                                                                    Index

                                                                                                                                                                    Enumeration Members

                                                                                                                                                                    production +TpayEnvironment | react-native-tpay
                                                                                                                                                                    react-native-tpay
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Enumeration TpayEnvironment

                                                                                                                                                                      Index

                                                                                                                                                                      Enumeration Members

                                                                                                                                                                      Enumeration Members

                                                                                                                                                                      production: "production"
                                                                                                                                                                      sandbox: "sandbox"
                                                                                                                                                                      +

                                                                                                                                                                      Enumeration Members

                                                                                                                                                                      production: "production"
                                                                                                                                                                      sandbox: "sandbox"
                                                                                                                                                                      diff --git a/docs/functions/TpayButton.html b/docs/functions/TpayButton.html index fbba7e8..7762e48 100644 --- a/docs/functions/TpayButton.html +++ b/docs/functions/TpayButton.html @@ -1 +1 @@ -TpayButton | react-native-tpay
                                                                                                                                                                      react-native-tpay
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Function TpayButton

                                                                                                                                                                        +TpayButton | react-native-tpay
                                                                                                                                                                        react-native-tpay
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Function TpayButton

                                                                                                                                                                          diff --git a/docs/functions/configure.html b/docs/functions/configure.html index 7d9ed5d..d93b3d0 100644 --- a/docs/functions/configure.html +++ b/docs/functions/configure.html @@ -1,3 +1,3 @@ configure | react-native-tpay
                                                                                                                                                                          react-native-tpay
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Function configure

                                                                                                                                                                            +
                                                                                                                                                                            diff --git a/docs/functions/configureGooglePayUtils.html b/docs/functions/configureGooglePayUtils.html index 7383184..54a67ad 100644 --- a/docs/functions/configureGooglePayUtils.html +++ b/docs/functions/configureGooglePayUtils.html @@ -1,4 +1,4 @@ configureGooglePayUtils | react-native-tpay
                                                                                                                                                                            react-native-tpay
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Function configureGooglePayUtils

                                                                                                                                                                              +

                                                                                                                                                                              Parameters

                                                                                                                                                                              Returns Promise<GooglePayConfigureResult>

                                                                                                                                                                              diff --git a/docs/functions/getAvailablePaymentChannels.html b/docs/functions/getAvailablePaymentChannels.html index e0bf4fe..3998133 100644 --- a/docs/functions/getAvailablePaymentChannels.html +++ b/docs/functions/getAvailablePaymentChannels.html @@ -1,2 +1,2 @@ getAvailablePaymentChannels | react-native-tpay
                                                                                                                                                                              react-native-tpay
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Function getAvailablePaymentChannels

                                                                                                                                                                                +

                                                                                                                                                                                Returns Promise<PaymentChannelsResult>

                                                                                                                                                                                diff --git a/docs/functions/isGooglePayAvailable.html b/docs/functions/isGooglePayAvailable.html index d01e8f2..ba0666c 100644 --- a/docs/functions/isGooglePayAvailable.html +++ b/docs/functions/isGooglePayAvailable.html @@ -1,4 +1,4 @@ isGooglePayAvailable | react-native-tpay
                                                                                                                                                                                react-native-tpay
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Function isGooglePayAvailable

                                                                                                                                                                                  • Method used to check if Google Pay is available

                                                                                                                                                                                    Android only

                                                                                                                                                                                    Returns Promise<Boolean>

                                                                                                                                                                                    true if Google Pay is available on the device

                                                                                                                                                                                    -
                                                                                                                                                                                  +
                                                                                                                                                                                  diff --git a/docs/functions/openGooglePay.html b/docs/functions/openGooglePay.html index f6c2d91..af0fc02 100644 --- a/docs/functions/openGooglePay.html +++ b/docs/functions/openGooglePay.html @@ -1,4 +1,4 @@ openGooglePay | react-native-tpay
                                                                                                                                                                                  react-native-tpay
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Function openGooglePay

                                                                                                                                                                                    +
                                                                                                                                                                                    diff --git a/docs/functions/screenlessAmbiguousBLIKPayment.html b/docs/functions/screenlessAmbiguousBLIKPayment.html index 62aee76..f423c15 100644 --- a/docs/functions/screenlessAmbiguousBLIKPayment.html +++ b/docs/functions/screenlessAmbiguousBLIKPayment.html @@ -1,2 +1,2 @@ screenlessAmbiguousBLIKPayment | react-native-tpay
                                                                                                                                                                                    react-native-tpay
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Function screenlessAmbiguousBLIKPayment

                                                                                                                                                                                      +

                                                                                                                                                                                      Parameters

                                                                                                                                                                                      Returns Promise<ScreenlessResult>

                                                                                                                                                                                      diff --git a/docs/functions/screenlessApplePayPayment.html b/docs/functions/screenlessApplePayPayment.html index 9d98424..edad80f 100644 --- a/docs/functions/screenlessApplePayPayment.html +++ b/docs/functions/screenlessApplePayPayment.html @@ -1,2 +1,2 @@ screenlessApplePayPayment | react-native-tpay
                                                                                                                                                                                      react-native-tpay
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Function screenlessApplePayPayment

                                                                                                                                                                                        +

                                                                                                                                                                                        Parameters

                                                                                                                                                                                        Returns Promise<ScreenlessResult>

                                                                                                                                                                                        diff --git a/docs/functions/screenlessBLIKPayment.html b/docs/functions/screenlessBLIKPayment.html index 21a4d6e..215ee56 100644 --- a/docs/functions/screenlessBLIKPayment.html +++ b/docs/functions/screenlessBLIKPayment.html @@ -1,2 +1,2 @@ screenlessBLIKPayment | react-native-tpay
                                                                                                                                                                                        react-native-tpay
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Function screenlessBLIKPayment

                                                                                                                                                                                          +

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Returns Promise<ScreenlessResult>

                                                                                                                                                                                          diff --git a/docs/functions/screenlessCreditCardPayment.html b/docs/functions/screenlessCreditCardPayment.html index ef5a76c..eff0709 100644 --- a/docs/functions/screenlessCreditCardPayment.html +++ b/docs/functions/screenlessCreditCardPayment.html @@ -1,2 +1,2 @@ screenlessCreditCardPayment | react-native-tpay
                                                                                                                                                                                          react-native-tpay
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Function screenlessCreditCardPayment

                                                                                                                                                                                            +

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            Returns Promise<ScreenlessResult>

                                                                                                                                                                                            diff --git a/docs/functions/screenlessGooglePayPayment.html b/docs/functions/screenlessGooglePayPayment.html index 19ade71..3a40947 100644 --- a/docs/functions/screenlessGooglePayPayment.html +++ b/docs/functions/screenlessGooglePayPayment.html @@ -1,2 +1,2 @@ screenlessGooglePayPayment | react-native-tpay
                                                                                                                                                                                            react-native-tpay
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Function screenlessGooglePayPayment

                                                                                                                                                                                              +

                                                                                                                                                                                              Parameters

                                                                                                                                                                                              Returns Promise<ScreenlessResult>

                                                                                                                                                                                              diff --git a/docs/functions/screenlessPayPoPayment.html b/docs/functions/screenlessPayPoPayment.html index 40779d0..7009781 100644 --- a/docs/functions/screenlessPayPoPayment.html +++ b/docs/functions/screenlessPayPoPayment.html @@ -1,2 +1,2 @@ screenlessPayPoPayment | react-native-tpay
                                                                                                                                                                                              react-native-tpay
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Function screenlessPayPoPayment

                                                                                                                                                                                                +

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                Returns Promise<ScreenlessResult>

                                                                                                                                                                                                diff --git a/docs/functions/screenlessRatyPekaoPayment.html b/docs/functions/screenlessRatyPekaoPayment.html index 0270c25..3474c4e 100644 --- a/docs/functions/screenlessRatyPekaoPayment.html +++ b/docs/functions/screenlessRatyPekaoPayment.html @@ -1,2 +1,2 @@ screenlessRatyPekaoPayment | react-native-tpay
                                                                                                                                                                                                react-native-tpay
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Function screenlessRatyPekaoPayment

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                  Returns Promise<ScreenlessResult>

                                                                                                                                                                                                  diff --git a/docs/functions/screenlessTransferPayment.html b/docs/functions/screenlessTransferPayment.html index 9b55635..b74d3b1 100644 --- a/docs/functions/screenlessTransferPayment.html +++ b/docs/functions/screenlessTransferPayment.html @@ -1,2 +1,2 @@ screenlessTransferPayment | react-native-tpay
                                                                                                                                                                                                  react-native-tpay
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Function screenlessTransferPayment

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    Returns Promise<ScreenlessResult>

                                                                                                                                                                                                    diff --git a/docs/functions/startCardTokenPayment.html b/docs/functions/startCardTokenPayment.html index 651f673..567783c 100644 --- a/docs/functions/startCardTokenPayment.html +++ b/docs/functions/startCardTokenPayment.html @@ -1,2 +1,2 @@ startCardTokenPayment | react-native-tpay
                                                                                                                                                                                                    react-native-tpay
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Function startCardTokenPayment

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      Returns Promise<Result>

                                                                                                                                                                                                      diff --git a/docs/functions/startPayment.html b/docs/functions/startPayment.html index 51adce6..184ab1a 100644 --- a/docs/functions/startPayment.html +++ b/docs/functions/startPayment.html @@ -1,2 +1,2 @@ startPayment | react-native-tpay
                                                                                                                                                                                                      react-native-tpay
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Function startPayment

                                                                                                                                                                                                        +

                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                        Returns Promise<Result>

                                                                                                                                                                                                        diff --git a/docs/functions/tokenizeCard.html b/docs/functions/tokenizeCard.html index 1a6e73e..24ee964 100644 --- a/docs/functions/tokenizeCard.html +++ b/docs/functions/tokenizeCard.html @@ -1,2 +1,2 @@ tokenizeCard | react-native-tpay
                                                                                                                                                                                                        react-native-tpay
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Function tokenizeCard

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          Returns Promise<Result>

                                                                                                                                                                                                          diff --git a/docs/index.html b/docs/index.html index 17b2fc9..688d2dc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,8 +1,10 @@ -react-native-tpay
                                                                                                                                                                                                          react-native-tpay
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            react-native-tpay

                                                                                                                                                                                                            Tpay React Native SDK

                                                                                                                                                                                                            npm version +react-native-tpay

                                                                                                                                                                                                            react-native-tpay
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              react-native-tpay

                                                                                                                                                                                                              Tpay React Native SDK

                                                                                                                                                                                                              +

                                                                                                                                                                                                              npm version Static Badge Static Badge License: MIT

                                                                                                                                                                                                              -

                                                                                                                                                                                                              This SDK allows your app to make payments with Tpay. +

                                                                                                                                                                                                              +

                                                                                                                                                                                                              This SDK allows your app to make payments with Tpay. Documentation is available here.

                                                                                                                                                                                                              @@ -36,28 +38,33 @@
                                                                                                                                                                                                              npm install react-native-tpay
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              npm install react-native-tpay
                                                                                                                                                                                                               
                                                                                                                                                                                                              -
                                                                                                                                                                                                              Note

                                                                                                                                                                                                              +

                                                                                                                                                                                                              +
                                                                                                                                                                                                              Note

                                                                                                                                                                                                              In this section we will provide examples for each configuration to the TpayConfiguration class you will be able to make.

                                                                                                                                                                                                              Important

                                                                                                                                                                                                              Beneath you will find all configurations that are MANDATORY.

                                                                                                                                                                                                              -

                                                                                                                                                                                                              At first, you have to configure your app to be able to make any requests by providing SDK info about +

                                                                                                                                                                                                              +

                                                                                                                                                                                                              At first, you have to configure your app to be able to make any requests by providing SDK info about your merchant account. Info about client_id and client_secret you will find in your merchant's panel at Integration -> API.

                                                                                                                                                                                                              new Merchant(
                                                                                                                                                                                                              new MerchantAuthorization(
                                                                                                                                                                                                              'client_id',
                                                                                                                                                                                                              'client_secret'
                                                                                                                                                                                                              ),
                                                                                                                                                                                                              TpayEnvironment.sandbox,
                                                                                                                                                                                                              new CertificatePinningConfiguration('ssl_pinning'),
                                                                                                                                                                                                              'blik_alias',
                                                                                                                                                                                                              new WalletConfiguration(
                                                                                                                                                                                                              new GooglePayConfiguration('merchant_id'),
                                                                                                                                                                                                              new ApplePayConfiguration('merchant_id', 'country_code')
                                                                                                                                                                                                              )
                                                                                                                                                                                                              );
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Tpay SDK provides two types of environments you can use in your app:

                                                                                                                                                                                                              + +

                                                                                                                                                                                                              Tpay SDK provides two types of environments you can use in your app:

                                                                                                                                                                                                              • TpayEnvironment.sandbox - used only for tests and in stage/dev flavor.
                                                                                                                                                                                                              • TpayEnvironment.production - used for production flavors.
                                                                                                                                                                                                              -

                                                                                                                                                                                                              For users to be able to use a specific payment method you have declare it in the configuration.

                                                                                                                                                                                                              + +

                                                                                                                                                                                                              For users to be able to use a specific payment method you have declare it in the configuration.

                                                                                                                                                                                                              @@ -95,7 +102,8 @@ +

                                                                                                                                                                                                              If you decide to enable the credit card payment option, you have to provide SSL certificates.

                                                                                                                                                                                                              Tip

                                                                                                                                                                                                              You can find SSL public key on you merchant panel at section Integrations -> API -> Cards API.

                                                                                                                                                                                                              @@ -109,14 +117,16 @@ +

                                                                                                                                                                                                              In order to be able to use Google Pay method you have to provide your merchant_id to the SDK.

                                                                                                                                                                                                              Tip

                                                                                                                                                                                                              Your login name to the merchant panel is your merchant id.

                                                                                                                                                                                                                new WalletConfiguration(
                                                                                                                                                                                                              new GooglePayConfiguration('merchant_id'),
                                                                                                                                                                                                              )
                                                                                                                                                                                                              -

                                                                                                                                                                                                              In order to be able to use Apple Pay method you have to provide your merchant_id and country_code to the SDK.

                                                                                                                                                                                                              + +

                                                                                                                                                                                                              In order to be able to use Apple Pay method you have to provide your merchant_id and country_code to the SDK.

                                                                                                                                                                                                              Important

                                                                                                                                                                                                              To obtain the merchantIdentifier, follow these steps:

                                                                                                                                                                                                                @@ -132,7 +142,8 @@

                                                                                                                                                                                                                Tpay SDK lets you decide what languages will be available in the Tpay's screen and which one of them +

                                                                                                                                                                                                                +

                                                                                                                                                                                                                Tpay SDK lets you decide what languages will be available in the Tpay's screen and which one of them will be preferred/default.

                                                                                                                                                                                                                Right now, SDK allows you to use 2 languages:

                                                                                                                                                                                                                  @@ -142,7 +153,8 @@ +

                                                                                                                                                                                                                  As a merchant, you can configure how information about you will be shown. You can set up your display name, city/headquarters and regulations link. You can choose to provide different copy for each language, or simply use one for all.

                                                                                                                                                                                                                  new MerchantDetails(
                                                                                                                                                                                                                  [
                                                                                                                                                                                                                  new LocalizedString(Language.pl, 'Sklep'),
                                                                                                                                                                                                                  new LocalizedString(Language.en, 'Merchant'),
                                                                                                                                                                                                                  ],
                                                                                                                                                                                                                  [
                                                                                                                                                                                                                  new LocalizedString(Language.pl, 'Warszawie'),
                                                                                                                                                                                                                  new LocalizedString(Language.en, 'Warsaw'),
                                                                                                                                                                                                                  ],
                                                                                                                                                                                                                  [
                                                                                                                                                                                                                  new LocalizedString(Language.pl, 'polish URL'),
                                                                                                                                                                                                                  new LocalizedString(Language.en, 'english URL'),
                                                                                                                                                                                                                  ]
                                                                                                                                                                                                                  ); @@ -152,11 +164,13 @@

                                                                                                                                                                                                                  Beneath you will find how a complete configuration should look like.

                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Beneath you will find how a complete configuration should look like.

                                                                                                                                                                                                                  const merchant = new Merchant(
                                                                                                                                                                                                                  new MerchantAuthorization(
                                                                                                                                                                                                                  'client_id',
                                                                                                                                                                                                                  'client_secret'
                                                                                                                                                                                                                  ),
                                                                                                                                                                                                                  TpayEnvironment.sandbox,
                                                                                                                                                                                                                  new CertificatePinningConfiguration('ssl_pinning'),
                                                                                                                                                                                                                  'blik_alias',
                                                                                                                                                                                                                  new WalletConfiguration(
                                                                                                                                                                                                                  new GooglePayConfiguration('merchant_id'),
                                                                                                                                                                                                                  new ApplePayConfiguration('merchant_id', 'country_code')
                                                                                                                                                                                                                  )
                                                                                                                                                                                                                  );

                                                                                                                                                                                                                  const merchantDetails = new MerchantDetails(
                                                                                                                                                                                                                  [
                                                                                                                                                                                                                  new LocalizedString(Language.pl, 'Sklep'),
                                                                                                                                                                                                                  new LocalizedString(Language.en, 'Merchant'),
                                                                                                                                                                                                                  ],
                                                                                                                                                                                                                  [
                                                                                                                                                                                                                  new LocalizedString(Language.pl, 'Warszawie'),
                                                                                                                                                                                                                  new LocalizedString(Language.en, 'Warsaw'),
                                                                                                                                                                                                                  ],
                                                                                                                                                                                                                  [
                                                                                                                                                                                                                  new LocalizedString(Language.pl, 'polish URL'),
                                                                                                                                                                                                                  new LocalizedString(Language.en, 'english URL'),
                                                                                                                                                                                                                  ]
                                                                                                                                                                                                                  );

                                                                                                                                                                                                                  const languages = new Languages(Language.pl, [Language.en, Language.pl]);

                                                                                                                                                                                                                  const paymentMethods = new PaymentMethods(
                                                                                                                                                                                                                  [PaymentMethod.card, PaymentMethod.blik, PaymentMethod.transfer],
                                                                                                                                                                                                                  [DigitalWallet.googlePay, DigitalWallet.applePay],
                                                                                                                                                                                                                  [InstallmentPayment.ratyPekao, InstallmentPayment.payPo]
                                                                                                                                                                                                                  );

                                                                                                                                                                                                                  const configuration = new TpayConfiguration(
                                                                                                                                                                                                                  merchant,
                                                                                                                                                                                                                  merchantDetails,
                                                                                                                                                                                                                  languages,
                                                                                                                                                                                                                  paymentMethods
                                                                                                                                                                                                                  );

                                                                                                                                                                                                                  await configure(configuration);
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Tpay UI module is a native Android bottom sheet. In order to handle system backpress events you need +

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Tpay UI module is a native Android bottom sheet. In order to handle system backpress events you need to add the following code to your Activity.

                                                                                                                                                                                                                  import com.tpay.util.TpayBackpressUtil;
                                                                                                                                                                                                                   
                                                                                                                                                                                                                  @@ -171,15 +185,18 @@ 
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  If you are using Proguard/R8 in your project, you have to add the following rules to the +

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  If you are using Proguard/R8 in your project, you have to add the following rules to the android/app/proguard-rules.pro file, to keep Tpay SDK classes.

                                                                                                                                                                                                                  # Keep all Tpay SDK classes
                                                                                                                                                                                                                   -keep class com.tpay.sdk.** { *; }
                                                                                                                                                                                                                   
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  When integrating the Tpay payment module into your app, it’s important to ensure that the necessary permissions are correctly set up to ensure a smooth user experience. +

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  When integrating the Tpay payment module into your app, it’s important to ensure that the necessary permissions are correctly set up to ensure a smooth user experience. The module allows the user to automatically fill the credit card form for secure payment processing. This feature requires you to setup the “Privacy - Camera Usage Description”.

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Integration Steps:

                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Integration Steps:

                                                                                                                                                                                                                  1. Open your project’s Info.plist file.
                                                                                                                                                                                                                  2. Add the key-value pair for the “Privacy - Camera Usage Description” permission, explaining the purpose of camera access. Clearly state that the camera is used to facilitate the automatic filling of the credit card form for secure payment processing.
                                                                                                                                                                                                                  3. @@ -188,7 +205,8 @@
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Integration Steps:

                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Integration Steps:

                                                                                                                                                                                                                  1. Open your project’s app.json file.
                                                                                                                                                                                                                  2. Add the key-value pair for the “Privacy - Camera Usage Description” permission, explaining the purpose of camera access. Clearly state that the camera is used to facilitate the automatic filling of the credit card form for secure payment processing.
                                                                                                                                                                                                                  3. @@ -198,21 +216,24 @@
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Tpay SDK provides two ways of handling payments:

                                                                                                                                                                                                                    • Official SDK screens - you can use Tpay's official screens where you just need to provide "soft" information, like price, description or payer info.
                                                                                                                                                                                                                    • Screenless - you can use screenless functionalities, where you set callbacks for payments and display all necessary information on your own screens.
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    To make integration with the SDK faster, we created 3 types of sheets that can be used to handle +

                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    To make integration with the SDK faster, we created 3 types of sheets that can be used to handle payments:

                                                                                                                                                                                                                    • SingleTransaction - the most simple screen where the user can choose any payment method and proceed with it,
                                                                                                                                                                                                                    • Tokenization - screen that handles generating payment token from the credit card,
                                                                                                                                                                                                                    • TokenPayment - screen that handles payment with previously created token for credit card,
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    SingleTransaction flow opens a UI module and allows the customer to pick one of the defined payment methods. +

                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    SingleTransaction flow opens a UI module and allows the customer to pick one of the defined payment methods. This method requires setting up a few things in order to fulfill payment:

                                                                                                                                                                                                              diff --git a/docs/types/TpayButtonProps.html b/docs/types/TpayButtonProps.html index 42c7ef5..df2eb7b 100644 --- a/docs/types/TpayButtonProps.html +++ b/docs/types/TpayButtonProps.html @@ -1,5 +1,5 @@ -TpayButtonProps | react-native-tpay
                                                                                                                                                                                                              react-native-tpay
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Type Alias TpayButtonProps

                                                                                                                                                                                                                type TpayButtonProps = {
                                                                                                                                                                                                                    isEnabled: boolean;
                                                                                                                                                                                                                    onClick: Function;
                                                                                                                                                                                                                }
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                isEnabled +TpayButtonProps | react-native-tpay
                                                                                                                                                                                                                react-native-tpay
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Type Alias TpayButtonProps

                                                                                                                                                                                                                  type TpayButtonProps = {
                                                                                                                                                                                                                      isEnabled: boolean;
                                                                                                                                                                                                                      onClick: Function;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  isEnabled: boolean

                                                                                                                                                                                                                  Whether the button should be enabled

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  onClick: Function

                                                                                                                                                                                                                  Called when button is clicked

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  onClick: Function

                                                                                                                                                                                                                  Called when button is clicked

                                                                                                                                                                                                                  +