On this page:

Attributes

METHOD TYPEE-commerce
PAYMENTS
PAYOUTS
REFUNDS
RECURRING

Introduction

Zip is a global Buy Now Pay Later (BNPL) provider that offers flexible payment solutions to consumers and businesses by enabling the split of a purchase into installments.

Zip supports partial refunds.

Supported Countries

Australia
United States

Supported Currencies

REST API 1.0

Payment Flow

To perform a payout transaction in the future, use the same userTokenId and userPaymentOptionId values that are generated in this payment transaction.

Generate a sessionToken.

For details, see Authentication.

Perform the payment by sending a /payment request with the following mandatory parameters:
- userTokenId
- amount
- currency
- paymentOption.alternativePaymentMethod class containing:
  - paymentMethod: "apmgw_zip"
- deviceDetails class containing:
  - ipAddress
- billingAddress class containing:
  - firstName
  - lastName
  - country
  - email
- userDetails class containing:
  - firstName
  - lastName
  - country
  - email

Example `/payment` Request

{
    "sessionToken": "b51e6cfcc1884cb595acfe878e62d1fa0111",
    "merchantId": "{{merchantId}}",
    "merchantSiteId": "{{merchantSiteId}}",
    "userTokenId": "SiltokenRO4021322rrr43tttt41",
    "clientUniqueId": "{{clientRequestId}}",
    "clientRequestId": "{{clientRequestId}}",
    "amount": "7",
    "currency": "AUD",
    "paymentOption": {
        "alternativePaymentMethod": {
            "paymentMethod": "apmgw_ZIP"
        }

},
    "billingAddress": {
        "firstName": "John",
        "lastName": "Doe",
        "country": "AU"
    },

"deviceDetails": {
        "ipAddress": "192.168.2.38"
    },
    "urlDetails": {
        "successUrl": "https://apmtest.gate2shop.com/ppp/defaultSuccess.do" ,
        "pendingUrl": "https://apmtest.gate2shop.com/ppp/defaultPending.do" ,
        "failureUrl": "https://apmtest.gate2shop.com/ppp/defaultCancel.do" ,
        "notificationUrl": "https://apmtest.gate2shop.com/ppptest/NotifyMerchantTest" 
    },
    "timeStamp": "{{timestamp}}",
    "checksum": "{{checksum}}"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to the URL provided in urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

Web SDK

Follow the steps to perform a payment using the Nuvei Web SDK integration.

1. Initiate a Session

Before submitting payment using the client-side Nuvei Web SDK, it is required to send the /openOrder API call.

2. Initialize the Web SDK

Instantiate the Web SDK with the sessionToken received from the server call to /openOrder.

3. Create an APM Payment

- paymentOption.alternativePaymentMethod class containing:
  - paymentMethod: "apmgw_zip"
- deviceDetails class containing:
  - ipAddress
- billingAddress class containing:
  - firstName
  - lastName
  - country
  - email
- userDetails class containing:
  - firstName
  - lastName
  - country
  - email

User Experience

Payment

The customer selects the Zip payment method.
The customer is redirected to a Zip screen to log into the Zip account.
The customer selects a payment method via Zip Pay or Zip Money.

The payment method options are available based on customer eligibility.

If successful, purchase completion is confirmed.

Testing

Australia

Integration testing is only available in Australia

- - - - user – [email protected]
      - password – test1234
      - Verification code: 123456

Tell us about your experience

Zip