Developer Documentation
Developer Documentation
Home
Zip

Account Pairing

Account pairing is an initiative aimed at a more seamless integration to Zip UK, designed to deliver a better user experience to customers.

By establishing a trusted authentication context between the merchant and Zip UK, we can deliver the following features:

  • ‘One-click’ purchasing from merchant website / mobile app
  • Real-time display / access to a customers Zip UK balance and spend limits
  • ‘Single sign-on’ to Zip UK from merchant

Requirements

In order to enable account pairing, a merchant must be able to securely store a customer pairing token. The merchant will then use this pairing token as the basis for accessing resources on Zip UK in a customer-level security context.

Pairing Flow

For a first-time pairing flow, a request is made to the create order endpoint, with the pairing.isRequested value set to true. When this property is set, a pairing code unique to a customer is made available at the corresponding get customer pair endpoint (i.e. the pairingToken)

Paired Orders

When any subsequent orders are made, this pairingToken can be supplied in the pairing.token value in the create order endpoint. When a valid pairing token is supplied, the customer will be automatically authenticated when arriving at Zip UK checkout.

Revocation

As part of our terms, we require the merchant to provide functionality to a user to ‘un-pair’ their Zip UK account. The only requirment to implement is to simply destroy the pairing token that is held against a given users’ account.

Zip UK users are able to revoke pairing tokens from the Zip UK customer portal. This needs to be considered when creating an order with a pairing token, or when exchanging the pairing token for an access token.

Live Example

The Market

The Market uses the account pairing function to seamlessly integrate with the Zip Pay in 4 platform.

When a new customer uses Zip through The Market for the first time, at checkout, they can choose to save their Zip information to their account in The Market. Once a connection is established through the use of a customer pairing token, the customers Zip balance and spend limits are displayed on product page widgets, and in the Payment Method section as shown below. Once an account is paired the customer also doesn’t need to re-enter their Zip email address / password which streamlines the checkout process.

Product Page Example

Checkout Example