Zip for Payment Pages

zip_logo.svg

Zip is a Buy Now Pay Later (BNPL) payment method based in Australia. This service allows customers to spread the cost of purchases over instalments. When selecting Zip, customers will be prompted to sign in to their Zip account. Once signed in, the customer can select their preferred credit/debit card and agree to the payment, before being redirected back to your website.

  Supported customer countries   GB
  Supported currencies   GBP
  Refunds   Full and partial refunds permitted.
  Chargebacks   Payments are not subject to chargebacks.
  Zero-authorisation

  Not supported.

  Recurring payments

  Not supported.

 

Configuration

  1. To enable this payment method on your account, please get in touch with your account manager.
    A test sandbox account will be provided, which you will need when testing your implementation.
  2. Modify your POST to Payment Pages as needed:

    Field name

    Required during payment session

    (Either included in POST by merchant or entered by customer on Payment Pages)

    Required in POST Description
    billingcountryiso2a Yes No The country entered for the billing address, using ISO2A format.
    billingcounty Yes No The billing county.
    billingemail Yes No The billing email address.
    billingfirstname Yes No The billing first name.
    billinglastname Yes No The billing last name.
    billingpostcode Yes No The billing postcode.
    billingpremise Yes No The billing premise / house no.
    billingstreet Yes No The billing street.
    billingtown Yes No The billing town.
    ruleidentifier No No

    If your POST to the Payment Pages already includes all fields required by the payment method, you can streamline the checkout process for the customer by also submitting ruleidentifier=STR-14.

    This allows the customer’s browser to immediately go to the pages hosted by the payment method to complete the transaction. (We refer to this as Journey C)

    Click here to learn about different journeys.

    settlestatus N/A No

    Including the settlestatus in the POST allows you to choose between offline and online settlement processes:

    • 0 - Offline settlement: Funds are settled in daily batches. While transactions are pending settlement, you can update or cancel if needed.
    • 100 - Online settlement: Funds are immediately settled into your bank account.

    If the settlestatus is not submitted, the payment is processed as offline settlement by default.

 

URL notification following payment

Before you begin testing, you will need to enable a rule which submits URL notifications to your system. You can use these notifications to update your own records as appropriate, and track the progress of orders. Notifications can be configured for the following scenarios:

When a payment is authorised (required)
  1. Sign in to MyST.

  2. Search for your sitereference using the search box found at the top of the page.

  3. When viewing your site details, click “Rule manager“.

    webhook-2010-01-en.png

  4. Select the action type “URL notification” from the drop-down and your browser will be redirected.

    webhook-2010-02-en.png

  5. Create a new URL notification rule: webhook-2010-03-en.png
      • (A) Click “Add new condition” and specify the circumstances in which the URL notification is to be triggered following a transaction. Ensure the following options are ticked:
      • (B) Click “Add new action” and specify the endpoint for the URL notification. We recommend including at least the following fields in the Action:
        • Acquirer Response Message (acquirerresponsemessage)
        • Base Amount (baseamount) (e.g. £10.50 is “1050”)*
        • Main Amount (mainamount) (e.g. £10.50 is “10.50”)*
        • *Please choose your preferred format.
        • Billing Country (billingcountryiso2a)
        • Currency (currencyiso3a)
        • Error Code (errorcode)
        • Live Status (livestatus)
        • Order Reference (orderreference)
        • Payment Type (paymenttypedescription)
        • Request Type (requesttypedescription)
        • Settle Status (settlestatus)
        • Site Reference (sitereference)
        • Transaction Reference (transactionreference)
        • Transaction Started Timestamp (transactionstartedtimestamp)
      • (C) Using the drop-down boxes, assign the condition to the action and click “Create rule“.


  6. Ensure the rule is active (this is shown with a tick under the Active column). Once enabled, the rule will be applied to all payment sessions for the given sitereference, and the URL notification will be triggered whenever a customer on your site is redirected to Zip's servers to complete a transaction.

    Note: All new rules should be created on your test sitereference and tested to ensure they work as expected before being added to your live sitereference.

  7. You will need to check in the notification received that the settle status is “10”, indicating that the payment authorisation process has been initiated and is waiting for the customer to complete the checkout on Zip's servers. After you have received this notification, you can create an order in your own records.

      You will not receive funds until the transaction has been settled, after which the settle status is updated to "100" (Settled).

     

  8. You must configure your system to respond to all URL notifications received from Trust Payments with an HTTP 200 OK response.
    For example: “HTTP/1.0 200 OK”.
    Your system must reply within 8 seconds of receiving a notification.

 

When funds have been settled into your bank account (recommended)

We recommend also configuring URL notifications that are sent to your system when Zip transactions are settled. In order to configure this, you will need to contact our Support Team and request this is enabled on your account. As part of this process, please request for the following fields to be returned in this notification:

  • Settle Status (settlestatus)
  • Site Reference (sitereference)
  • Transaction Reference (transactionreference)

You will need to check the notification received. If the settlestatus is “100”, this indicates that the funds have been settled. However, a value of “3” indicates there has been a problem and the payment was subsequently cancelled.

You must configure your system to respond to all URL notifications received from Trust Payments with an HTTP 200 OK response.
For example: “HTTP/1.0 200 OK”.
Your system must reply within 8 seconds of receiving a notification.

 

Settlement

Once the customer has been redirected from our hosted Payment Pages to Zip's servers to complete the payment, a transaction will be recorded in our system with settle status "10" (Settling). It will stay in this state until the customer completes the payment on Zip's system. The events that follow are determined by whether you are processing Zip payments with offline or online settlement, as described below:

  • Offline settlement (default): Funds are settled in daily batches. While transactions are pending settlement, they will be shown in MyST with settle status 0 (Pending). During this time, you can update or cancel the transaction if needed. Once funds have been captured, the settle status will update to "100" (Settled).
  • Online settlement: Funds are immediately settled into your bank account. Settled transactions are shown in MyST with settle status 100 (Settled).

 

Testing

You will need to test your solution before you can begin processing live payments. Test transactions are processed through your test Site Reference.

  Requirements

You will need to contact our Support Team, providing your Zip test account details. We will then configure your test site reference to connect directly to the Zip testing environment.

When performing test transactions, you will be redirected to the Zip testing environment to simulate a payment. The process you will follow is exactly the same as when processing live payments. As part of this process, Zip will prompt you to enter a real mobile phone number that you will need in order to complete two-factor authentication.

 

Refunds

After processing a payment, it is possible to refund the customer using MyST. Click here to learn how.

Refunds for Zip are settled immediately (settlestatus “100”). Full and partial refunds are supported.

 

Requirements

  • You cannot refund a payment until the AUTH has been settled (settlestatus is “100”).
  • You cannot refund a greater amount than was originally settled.

The REFUND request and response for Zip payments follow the same field specification as outlined in our standard REFUND documentation. Click here for further information.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request