Merchant Integration Guide Introduction

Paze is an online payment method designed to simplify and secure payments for both merchants and customers. Functioning as a digital wallet, Paze allows customers to pay online without exposing their actual card numbers to merchants. The user experience is seamless—there is no separate app for customers to download and integration is straightforward for merchants.

Supported Countries

United States

Supported Currencies

USD

Key Features

• Digital Wallet Experience – Paze enables online payments by tokenizing customer card information, thereby significantly reducing risk and PCI compliance burdens.
• No App Required – A customer interacts with a ‘Paze’ button displayed on your checkout page or on the Nuvei Simply Connect integration to initiate a checkout using a bank-associated email address.
• Automatic Card Enrollment – Each participating bank automatically adds eligible card(s) to the customer’s Paze wallet.  No manual enrollment is required.
• Strong Authentication – A customer receives a one-time passcode (OTP) via SMS to verify identity at checkout. Passkey is supported.
• Network Tokens – Paze replaces sensitive card details with network tokens, enhancing security and making card updates seamless even if a card is reissued.

Customer Checkout Flow

1. To initiate payment, the customer clicks the ‘Paze’ button or enters a bank-associated email at checkout.
2. The customer authenticates via a one-time password (OTP) or passkey.
3. Upon successful authentication, eligible cards (automatically added by participating banks) are displayed for selection.
4. The customer selects a card and confirms the payment.
5. Paze transmits a network token to the merchant, never exposing the real card number of the customer.
6. The purchase is either approved, declined, or failed due to an error.

User Experience

Integration Options

The merchant chooses the integration method that best fits the merchant’s existing payment infrastructure and technical resources. Paze is supported by the following integrations:

• REST 2.0 API
• Web SDK 2.0
• Simply Connect 2.0
• REST 1.0

Security and Card Lifecycle Management

• Paze leverages tokenization to enhance transaction security. Each merchant receives a unique token which prevents exposure of actual card numbers.
• If a customer’s card is reissued or updated network tokens are updated automatically, ensuring uninterrupted service and reducing administrative overhead for both the merchant and the customer.

Benefits for Merchants

• Reduced PCI scope by handling tokenized card data.
• Lower fraud risk due to advanced authentication and tokenization.
• Streamlined user experience with no additional apps or manual card entry.
• Automatic card updates for reissued cards, reducing failed transactions.

Merchant Registration

REST 2.0

REST 2.0 Integration Flow

This section provides a detailed integration flow and integration flow diagram.

1. The merchant calls GET /entities/{entity-id}/client-info to get the customer id value and name value from Paze.
2. The merchant UI calls the initialize() function, using the customer id and name values in the call.
3. To initiate a checkout session, the customer clicks the ‘Paze’ button.
4. The merchant UI calls the checkout() function, using transactional information (email, phone, amount, currency) in the call.
5. The Paze UI launches.
6. If the email and phone number are not provided by the merchant, the customer authenticates using email and phone number.
7. The checkout () function returns, among other details, the maskedCardData object that should be stored by the merchant.
8. The merchant UI calls the complete() function to obtain the completeResponse as returned from the complete() function. The completeResponse returns, among other details, the actual network token that is used for processing and the cryptogram.
9. From completeResponse, the merchant adds the maskedCardData property to create a pazeToken.
10. From the checkout() response, the merchant assigns the value of the stored maskedCardData.
11. The merchant encodes the pazeToken with Base64 and provides the encoded result as the value of the token property in the payment request.
12. The merchant UI sends via REST 2.0 a POST /payments endpoint request.
13. Schemes respond to REST 2.0 with the transaction status.
14. REST 2.0 returns a response to the merchant UI.

REST 2.0 Integration Flow Diagram

REST 2.0 Implementation

Example Response

{
    "client": {
        "id": "paze id",
        "name": "merchant name"
    },
    "result": {
        "status": "success"
    }
}
 

If the Merchant invokes the POST /payments or POST /orders/payments endpoints, the merchant should provide the data in the request as shown in the following example.

Example Request

{
  "paymentOption": {
    "networkToken": {
      "tokenProvider": "Paze",
      "token": "ewogICJ0eXBlIjogIm9iamVjdCIsCiAgInByb3BlcnRpZXMiOiB7CiAgICAiX2lkIjogewogICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAiZGVzY3JpcHRpb24iOiAiS2V5IGFzIHJlcXVpcmVkIGJ5IHRoZSBtaWNyb3NlcnZpY2UgLSBLZXlJRCBmcm9tIHRoZSBjZXJ0aWZpY2F0ZSIKICAgIH0sCiAgICAiY2VydGlmaWNhdGUiOiB7CiAgICAgICJ0eXBlIjogInN0cmluZyIsCiAgICAgICJtaW5MZW5ndGgiOiAxLAogICAgICAiZm9ybWF0IjogImJ5dGUiLAogICAgICAiZGVjcmlwdGlvbiI6ICJUaGUgY2VydGlmaWNhdGUgaW4gcDEyIGZvcm1hdCIKICAgIH0sCiAgICAiZXhwaXJlc0F0IjogewogICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAiZm9ybWF0IjogImRhdGUtdGltZSIKICAgIH0sCiAgICAiY3JlYXRlZEF0IjogewogICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAiZm9ybWF0IjogImRhdGUtdGltZSIKICAgIH0sCiAgICAibW9kaWZpZWRBdCI6IHsKICAgICAgInR5cGUiOiBbCiAgICAgICAgIm51bGwiLAogICAgICAgICJzdHJpbmciCiAgICAgIF0sCiAgICAgICJmb3JtYXQiOiAiZGF0ZS10aW1lIgogICAgfQogIH0sCiAgInJlcXVpcmVkIjogWwogICAgIl9pZCIsCiAgICAiY2VydGlmaWNhdGUiLAogICAgImV4cGlyZXNBdCIsCiAgICAiY3JlYXRlZEF0IgogIF0KfQ=="
    }
  }
}

Nuvei supports the following operations with Paze: payments, payouts, settlements, refunds, and voids.

Example Response

{
  "paymentId": "2c71acd502c64413b8edab7340097d02",
  "transactionId": "2110000000021949102",
  "externalTransactionId": "526805192182",
  "amount": 19.64,
  "currency": "USD",
  "transactionType": "Sale",
  "result": {
    "status": "approved"
  },
  "authCode": "070630",
  "partialApproval": {
    "requestedAmount": 19.64,
    "requestedCurrency": "USD"
  },
  "paymentOption": {
    "networkToken": {
      "provider": "Paze",
      "eciIndicator": "07",
      "expirationMonth": "05",
      "expirationYear": "32",
      "bin": "455955",
      "last4Digits": "2906",
      "acquirerId": "103",
      "cardType": "Debit",
      "cardBrand": "VISA"
    }
  }
}

REST 1.0

REST 1.0 Integration Flow

This section provides a detailed integration flow and integration flow diagram.

1. The merchant calls getClientInfo to get the customer id value and name value from Paze.
2. The merchant UI calls the initialize() function, using the customer id and name values in the call.
3. To initiate a checkout session, the customer clicks the ‘Paze’ button.
4. The merchant UI calls the checkout() function, using transactional information (email, phone, amount, currency) in the call.
5. The Paze UI launches.
6. If the email and phone number are not provided by the merchant, the customer authenticates using email and phone number.
7. The checkout () function returns, among other details, the maskedCardData object that should be stored by the merchant.
8. The merchant UI calls the complete() function to obtain the completeResponse as returned from the complete() function. The completeResponse returns, among other details, the actual network token that is used for processing and the cryptogram.
9. From completeResponse, the merchant adds the maskedCardData property to create a pazeToken.
10. From the checkout() response, the merchant assigns the value of the stored maskedCardData.
11. The merchant encodes the pazeToken with Base64 and provides the encoded result as the value of the token property in the payment request.
12. The merchant UI sends via REST 1.0 a POST /payments endpoint request.
    
    If the decryption is done by Nuvei, the encrypted data token is passed in paymentOption.card.externalToken.mobileToken
    If the merchant encrypts the data then the following dedicated parameters are exposed:
    paymentOption.card.cardNumber – Paze network token number
    paymentOption.card.expirationMonth – PAN expiration month
    paymentOption.card.expirationYear – PAN expiration year
    paymentOption.card.brand – card brand
    paymentOption.card.cardType – card type (such as debit/credit)
    paymentOption.card.last4Digits – last 4 of the PAN
    paymentOption.card.externalToken.externalTokenProvider – “Paze“
    paymentOption.card.externalToken.cryptogram – trx cryptogram from Paze
    paymentOption.card.externalToken.eciProvider: eciIndicator – from Paze

13. Schemes respond to REST 1.0 with the transaction status.
14. REST 1.0 returns a response to the merchant UI.

REST 1.0 Integration Flow Diagram

REST 1.0 Implementation

Example Request

{
"sessionToken": "<<your session token>>",
"merchantId": "<<your merchantId>>",
"merchantSiteId": "<<your merchantSiteId>>"
}

Example Response

{
"internalRequestId": 1760598204598,
"status": "SUCCESS",
"errCode": 0,
"merchantId": "<<your merchantId>>",
"merchantSiteId": "<<your merchantSiteId>>",
"version": "1.0",
"sessionToken": "<<your session token>>",
"paze": {
"id": "F5XKSMPIY2IO6GLDSHEK13JZ2lOl_wajs5oO7FBT5zXrTUX7E",
"name": "Nuvei",
"profileId": "Nuvei"
}
}

Example POST Request to /payment.do with Decrypted Card Token

[...]
"paymentOption": {
"card": {
"cardNumber": "5****5377",
"cardHolderName": "FL-BRW1",
"expirationMonth": "02",
"expirationYear": "2032",
"brand": "Mastercard",
"last4Digits": "5208",
"externalToken": {
"externalTokenProvider": "Paze",
"eciProvider": "7",
"cryptogram": "AwAAAAAAUjULbRAAAAAAgQIAAAA=",
}
[...]

Example Response for Decrypted Card Token

"paymentOption": {
"card": {
[...]
"externalTokenProvider": "Paze",
[...]
}
}

Example POST Request to /payment do with Encrypted Card Token

[...]
"paymentOption": {
"card": {
"externalToken": {
"externalTokenProvider": "Paze",
"mobileToken": "ICB7C***XQ3ciCiAgfQ==",
},
},
}
[...]

Example Response for Encrypted Card Token

"paymentOption": {
"card": {
[...]
"externalTokenProvider": "Paze",
[...]
}
}

Web SDK

Web SDK 2.0 Implementation Flow

1. The merchant must first initialize the Nuvei WebSDK 2.0 using the regular flow.
2. The merchant can get the account payment methods list and the payment tokens list. This enables the merchant to check if the Paze payment method is one of the supported methods for the merchant location and is in the merchant configuration with Nuvei.
3. If the Paze payment method is one of the supported methods for the merchant location and is in the merchant configuration with Nuvei, then merchant should initialize the Paze payment method by evoking a dedicated pazeInitialization() method for WebSDK 2.0.
4. The WebSDK 2.0 pazeInitialization() method returns a response that includes the state indicating if the Paze SDK is initialized successfully or not.
   Request/Response Example: sdkInstance.pazeInitialization().then(console.log)
The method initializePaze returns {initializedPaze: true}.
5. Based on the response, the merchant is responsible of displaying the ‘Paze’ button in the merchant user-interface.
   

   Example CSS

   {
     "paze-button": {
       "padding": "30px 65px",
       "background-color": "#0f42f8",
       "color": "white",
       "border": "none",
       "border-radius": "4px",
       "cursor": "pointer"
     }
   }
   

6. If an end-user presses the ‘Paze’ button in the merchant UI, the merchant must call a second dedicated WebSDK 2.0 method: checkoutWithPaze()
7. If evoked, WebSDK 2.0 is notified that a Paze payment is requested and then notifies Paze.
8. Paze automatically redirects the end-user to an authentication page where the end-user selects a card within the Paze profile. See User Experience.
9. If end-user authentication is successful, WebSDK 2.0 automatically ensures that Paze handles the payment request.
10. WebSDK 2.0 informs the merchant of the outcome of the transaction request by making available the back-end response object copy in the console.
11. The merchant must verify the outcome of the transaction according to the WebSDK 2.0 transaction verification flow.

Web SDK Paze Flow Diagram

Simply Connect

Simply Connect 2.0 Integration Flow

1. 1. The merchant initializes Simply Connect 2.0.
   2. Simply Connect 2.0 checks if the Paze payment method is configured for your processingEntityId.
   3. If Paze is configured, on loading of the payment page at the end of the regular initialization step Simply Connect 2.0 displays the Paze button in the user-interface.
   4. On initialization of Simply Connect 2.0, a merchant can control the display of the Paze button within payment pages using apmConfig settings.
   5. Using the property and value buttonLocation: onTop, within the apmConfig block a merchant renders the Paze button above of the card fields, nested within the card fields block.

Example Code

simplyConnect({
    uiConfig: {
        apmConfig: {
            paze: {
                buttonLocation: 'onTop',
            }
        }
    }
});

6. Using the property and value buttonLocation: gallery within the apmConfig block, a merchant renders the Paze button within the available payment methods list as a separate payment method in its own frame.

Example Code

simplyConnect({
    uiConfig: {
        apmConfig: {
            paze: {
                buttonLocation: 'gallery',
            }
            ,
        }
        ,
    }
    ,
});

7. When an end user presses the Paze button on the payment page, the Paze authentication user-interface is displayed for the end-user.
   1. 1. If the merchants sends user detail parameters (email and/or phone number) within the POST /orders request, then the end-user is automatically recognized by the Paze system.
         
      2. If the user detail parameters are not provided in the POST /orders request by the merchant, then the Paze login uesr-interface is displayed for the end-user.
         

8. After successful authentication, the end-user selects a card in the Paze profile. See User Experience.
9. Simply Connect 2.0 and Paze automatically handle the payment request.
10. The payment status is returned to Simply Connect 2.0 via the usual payment response from the back-end and displays a status message for the end-user.
11. Simply Connect 2.0 informs the merchant of the status of the transaction request via the back-end response object copy in the console.
12. The merchant must verify the status of the transaction as per the Simply Connect 2.0 transaction verification flow.

Simply Connect 2.0 Paze Payment Flow

User Scenarios Provided by Paze

First Time User Experience – https://developer.paze.com/public/docs/user-scenarios
Recognized Returning User Experience – https://developer.paze.com/public/docs/user-scenarios-copy
Implementing Paze Button (for a merchant with a merchant UI) – https://developer.paze.com/public/docs/merchant-integration-guide