Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Zip Component

Add Zip to your Web Components integration.

Our Zip Component renders Zip in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

When making a Zip payment, you also need to:

  1. Collect shopper details, and specify these in your payment request. Zip uses these for risk checks.
  2. Provide information about the purchased items in your payment request.

Before you begin

This page explains how to add Zip to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Zip integration:

  1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
  2. Add Zip in your Customer Area.

Show Zip in your payment form

To show Zip Component in your payment form, you need to:

  1. Specify in your /paymentMethods request:

  2. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

  3. Add the Zip Component:
    a. Create a DOM element for Zip, placing it where you want the form to be rendered:
    <div id="zip-container"></div>

    b. Create and mount an instance of the Zip Component using its component name, zip. This renders a button on your payment form.

    function handleOnSubmit(state, component) {
        // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
        state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
        state.data // Provides the data that you need to pass in the `/payments` call.
        component // Provides the active component instance that called this event.
    }
    const zipComponent =  checkout.create('zip', {
        onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
    }).mount('#zip-container');

    When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

Make a payment

From your server, make a POST /payments, specifying:

  • paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
  • returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.
  • paymentMethod.clickAndCollect Optional: Set this to true if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.
  • deliveryAddress Optional: Object that contains the postal address where the goods will be shipped. If the shopper chooses to pick up and collect their order and you set paymentMethod.clickAndCollect to true, you can omit this object from the request.
  • billingAddress: Object that contains the postal address to be included on the invoice. 
  • shopperName: Object that contains the shopper's full name, and gender (if specified). 
  • shopperEmail: The shopper's email address.  
  • telephoneNumberOptional: The shopper's phone number.
  • dateOfBirthOptional: The shopper's date of birth.
  • lineItems: Object that contains price and product information about the purchased items.  
    • description: Item description.
    • quantity: Number of items.
    • amountIncludingTax: Item amount including the tax, in minor units.
    • id: Line item ID.
    • imageURL Optional: URL of an image displayed for the item on the Zip product page — the shopper will see this image when they log into their Zip account. Maximum of 500 characters.

Below are examples of how you would make a payment request for 10 AUD depending on the shopper's choice of delivery or pick-up:

curl https://checkout-test.adyen.com/v65/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"AUD",
    "value":1000
  },
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "type":"zip"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..",
  "countryCode":"AU",
  "shopperName":{
     "firstName":"Happy",
     "lastName":"Testing",
     "gender":"UNKNOWN"
  },
  "telephoneNumber":"+85121212121",
  "billingAddress":{
     "city":"Sydney",
     "country":"AU",
     "houseNumberOrName":"123",
     "postalCode":"2000",
     "stateOrProvince":"NSW",
     "street":"Happy Street"
  },
  "deliveryAddress":{
     "city":"Sydney",
     "country":"AU",
     "houseNumberOrName":"123",
     "postalCode":"2000",
     "stateOrProvince":"NSW",
     "street":"Happy Street"
  },
  "lineItems":[
     {
        "description":"Shoes",
        "quantity":"1",
        "amountIncludingTax":"400",
        "id":"Item #1"
     },
     {
        "description":"Socks",
        "quantity":"2",
        "amountIncludingTax":"300",
        "id":"Item #2"
     }
  ]
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :reference => "YOUR_ORDER_NUMBER",
  :amount => {
    :currency => "AUD",
    :value => 1000
  },
  :paymentMethod => {
    :type => "zip"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :countryCode => "AU",
  :shopperName => [
    :firstName => "Happy",
    :lastName => "Testing",
    :gender => "UNKNOWN"
  ],
  :shopperEmail => "shopper@email.com",
  :dateOfBirth => "1981-01-13",
  :telephoneNumber => "+85121212121",
  :billingAddress => {
    :city => "Sydney",
    :country => "AU",
    :houseNumberOrName => "123",
    :postalCode => "2000",
    :stateOrProvince => "NSW",
    :street => "Happy Street"
  },
  :deliveryAddress => {
    :city => "Sydney",
    :country => "AU",
    :houseNumberOrName => "123",
    :postalCode => "2000",
    :stateOrProvince => "NSW",
    :street => "Happy Street"
  },
  :lineItems => [
    {
      :description => "Shoes",
      :quantity => "1",
      :amountIncludingTax => "400",
      :id => "Item #1"
    },
    {
      :description => "Socks",
      :quantity => "2",
      :amountIncludingTax => "300",
      :id => "Item #2"
    }
  ]
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("AUD");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("zip");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    BillingAddress billingAdress = new BillingAddress();
    billingAddress.setCountry("AU");
    billingAddress.setCity("Sydney");
    billingAddress.setHouseNumberOrName("123");
    billingAddress.setStreet("Happy Street");
    billingAddress.setPostalCode("2000");
    billingAddress.setStateOrProvince("NSW");

    paymentsRequest.setBillingAddress(billingAddress);

    DeliveryAddress deliveryAddress = new DeliveryAddress();
    deliveryAddress.setCountry("AU");
    deliveryAddress.setCity("Sydney");
    deliveryAddress.setHouseNumberOrName("123");
    deliveryAddress.setStreet("Happy Street");
    deliveryAddress.setPostalCode("2000");
    deliveryAddress.setStateOrProvince("NSW");

    paymentsRequest.setDeliveryAddress(deliveryAddress);

    deliveryAddress.setCountry("AU");
    deliveryAddress.setCity("Sydney");
    deliveryAddress.setHouseNumberOrName("123");
    deliveryAddress.setStreet("Happy Street");
    deliveryAddress.setPostalCode("2000");
    deliveryAddress.setStateOrProvince("NSW");

    List<LineItem> lineItems = new ArrayList<>();
    lineItems.add(
    new LineItem()
    .quantity(1L)
    .description("Shoes")
    .id("Item #1")
    .amountIncludingTax(400L)
    );
    lineItems.add(
    new LineItem()
    .quantity(2L)
    .description("Socks")
    .id("Item #2")
    .amountIncludingTax(300L)
    );

    paymentsRequest.setLineItems(lineItems);

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = [
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT",
  "reference" => "YOUR_ORDER_NUMBER",
  "amount" => [
    "currency" => "AUD",
    "value" => 1000
  ],
  "paymentMethod" => [
    "type" => "zip"
  ],
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "countryCode" => "AU",
  "shopperName" => [
       "firstName" => "Happy",
       "lastName" => "Testing",
       "gender" => "UNKNOWN"
  ],
  "shopperEmail" => "shopper@email.com",
  "dateOfBirth" => "1981-01-13",
  "telephoneNumber" => "+85121212121",
  "billingAddress" => [
       "city" => "Sydney",
       "country" => "AU",
       "houseNumberOrName" => "123",
       "postalCode" => "2000",
       "stateOrProvince" => "NSW",
       "street" => "Happy Street"
  ],
  "deliveryAddress" => [
       "city" => "Sydney",
       "country" => "AU",
       "houseNumberOrName" => "123",
       "postalCode" => "2000",
       "stateOrProvince" => "NSW",
       "street" => "Happy Street"
  ],
  "lineItems" => [
     [
        "description" => "Shoes",
        "quantity" => "1",
        "amountIncludingTax" => "400",
        "id" => "Item #1"
     ],
     [
        "description" => "Socks",
        "quantity" => "2",
        "amountIncludingTax" => "300",
        "id" => "Item #2"
     ]
    ]
];
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
   "reference": "YOUR_ORDER_NUMBER",
   "amount": {
      "value": 1000,
      "currency": "AUD"
   },
   "paymentMethod": {
      "type": "zip"
   },
   "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
   "countryCode":"AU",
   "shopperName": {
      "firstName":"Happy",
      "lastName":"Testing",
      "gender":"UNKNOWN"
   },
   "shopperEmail":"shopper@email.com",
   "dateOfBirth": "1981-01-13",
   "telephoneNumber":"+85121212121",
   "billingAddress":{
      "city":"Sydney",
      "country":"AU",
      "houseNumberOrName":"123",
      "postalCode":"2000",
      "stateOrProvince":"NSW",
      "street":"Happy Street"
   },
   "deliveryAddress":{
      "city":"Sydney",
      "country":"AU",
      "houseNumberOrName":"123",
      "postalCode":"2000",
      "stateOrProvince":"NSW",
      "street":"Happy Street"
   },
   "lineItems":[
      {
         "description":"Shoes",
         "quantity":"1",
         "amountIncludingTax":"400",
         "id":"Item #1"
      },
      {
         "description":"Socks",
         "quantity":"2",
         "amountIncludingTax":"300",
         "id":"Item #2"
      }
   ]
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
   MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
   Reference = "YOUR_ORDER_REFERENCE",
   PaymentMethod = new DefaultPaymentMethodDetails { Type = "zip" },
   Amount = new Model.Checkout.Amount(Currency: "AUD", Value: 1000),
   CountryCode = "AU",
   ShopperEmail = "shopper@email.com",
   DateOfBirth = "1981-01-13",
   TelephoneNumber = "+85121212121",
   ShopperName = new Model.Checkout.Name
   {
       FirstName = "Happy",
       Gender = Model.Checkout.Name.GenderEnum.UNKNOWN,
       LastName = "Testing"
   },
   BillingAddress = new Model.Checkout.Address
   {
       City = "Sydney",
       Country = "AU",
       HouseNumberOrName = "123,
       PostalCode = "2000",
       Street = "Happy Street"
   },
   DeliveryAddress = new Model.Checkout.Address
   {
      City = "Sydney",
      Country = "AU",
      HouseNumberOrName = "123,
      PostalCode = "2000",
      Street = "Happy Street"
   },
   ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy..",
   LineItems = new List<LineItem>
   {
     new LineItem(Quantity:1, Description:"Shoes",Id:"Item #1", AmountIncludingTax:400),
     new LineItem(Quantity:2, Description:"Shoes",Id:"Item #2", AmountIncludingTax:300),
   }
};
return paymentRequest;
}
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: {
       currency: "AUD",
       value: 1000
    },
    paymentMethod: {
        type: 'zip'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
    countryCode: "AU",
    shopperName: {
        firstName: "Happy",
        lastName: "Testing",
        gender: "UNKNOWN"
    },
    shopperEmail: "shopper@email.com",
    dateOfBirth: "1981-01-13",
    telephoneNumber:"+85121212121",
    billingAddress: {
        city:"Sydney",
        country:"AU",
        houseNumberOrName:"123",
        postalCode:"2000",
        stateOrProvince:"NSW",
        street:"Happy Street"
    },
    deliveryAddress: {
        city:"Sydney",
        country:"AU",
        houseNumberOrName:"123",
        postalCode:"2000",
        stateOrProvince:"NSW",
        street:"Happy Street"
    },
    lineItems: [
       {
          description":"Shoes",
          quantity:"1",
          amountIncludingTax:"400",
          id:"Item #1"
       },
       {
          description:"Socks",
          quantity:"2",
          amountIncludingTax:"300",
          id:"Item #2"
       }
    ]
}).then(res => res);
curl https://checkout-test.adyen.com/v65/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"AUD",
    "value":1000
  },
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "type":"zip",
    "clickAndCollect": true
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..",
  "countryCode":"AU",
  "shopperName":{
     "firstName":"Happy",
     "lastName":"Testing",
     "gender":"UNKNOWN"
  },
  "shopperEmail":"shopper@email.com",
  "dateOfBirth": "1981-01-13",
  "telephoneNumber":"+85121212121",
  "billingAddress":{
     "city":"Sydney",
     "country":"AU",
     "houseNumberOrName":"123",
     "postalCode":"2000",
     "stateOrProvince":"NSW",
     "street":"Happy Street"
  },
  "lineItems":[
     {
        "description":"Shoes",
        "quantity":"1",
        "amountIncludingTax":"400",
        "id":"Item #1"
     },
     {
        "description":"Socks",
        "quantity":"2",
        "amountIncludingTax":"300",
        "id":"Item #2"
     }
  ]
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :reference => "YOUR_ORDER_NUMBER",
  :amount => {
    :currency => "AUD",
    :value => 1000
  },
  :paymentMethod => {
    :type => "zip",
    :clickAndCollect => "true"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :countryCode => "AU",
  :shopperName => [
    :firstName => "Happy",
    :lastName => "Testing",
    :gender => "UNKNOWN"
  ],
  :shopperEmail => "shopper@email.com",
  :dateOfBirth => "1981-01-13",
  :telephoneNumber => "+85121212121",
  :billingAddress => {
    :city => "Sydney",
    :country => "AU",
    :houseNumberOrName => "123",
    :postalCode => "2000",
    :stateOrProvince => "NSW",
    :street => "Happy Street"
  },
  :lineItems => [
    {
      :description => "Shoes",
      :quantity => "1",
      :amountIncludingTax => "400",
      :id => "Item #1"
    },
    {
      :description => "Socks",
      :quantity => "2",
      :amountIncludingTax => "300",
      :id => "Item #2"
    }
  ]
})
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = [
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT",
  "reference" => "YOUR_ORDER_NUMBER",
  "amount" => [
    "currency" => "AUD",
    "value" => 1000
  ],
  "paymentMethod" => [
    "type" => "zip",
    "clickAndCollect" => "true"
  ],
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "countryCode" => "AU",
  "shopperName" => [
       "firstName" => "Happy",
       "lastName" => "Testing",
       "gender" => "UNKNOWN"
  ],
  "shopperEmail" => "shopper@email.com",
  "dateOfBirth" => "1981-01-13",
  "telephoneNumber" => "+85121212121",
  "billingAddress" => [
       "city" => "Sydney",
       "country" => "AU",
       "houseNumberOrName" => "123",
       "postalCode" => "2000",
       "stateOrProvince" => "NSW",
       "street" => "Happy Street"
  ],
  "lineItems" => [
     [
        "description" => "Shoes",
        "quantity" => "1",
        "amountIncludingTax" => "400",
        "id" => "Item #1"
     ],
     [
        "description" => "Socks",
        "quantity" => "2",
        "amountIncludingTax" => "300",
        "id" => "Item #2"
     ]
  ]
];
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
   "reference": "YOUR_ORDER_NUMBER",
   "amount": {
      "value": 1000,
      "currency": "AUD"
   },
   "paymentMethod": {
      "type": "zip",
      "clickAndCollect": "true"
   },
   "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
   "countryCode":"AU",
   "shopperName": {
      "firstName":"Happy",
      "lastName":"Testing",
      "gender":"UNKNOWN"
   },
   "shopperEmail":"shopper@email.com",
   "dateOfBirth": "1981-01-13",
   "telephoneNumber":"+85121212121",
   "billingAddress":{
      "city":"Sydney",
      "country":"AU",
      "houseNumberOrName":"123",
      "postalCode":"2000",
      "stateOrProvince":"NSW",
      "street":"Happy Street"
   },
   "lineItems":[
      {
         "description":"Shoes",
         "quantity":"1",
         "amountIncludingTax":"400",
         "id":"Item #1"
      },
      {
         "description":"Socks",
         "quantity":"2",
         "amountIncludingTax":"300",
         "id":"Item #2"
      }
   ]
})
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: {
       currency: "AUD",
       value: 1000
    },
    paymentMethod: {
        type: 'zip',
        clickAndCollect: 'true'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
    countryCode: "AU",
    shopperName: {
        firstName: "Happy",
        lastName: "Testing",
        gender: "UNKNOWN"
    },
    shopperEmail: "shopper@email.com",
    dateOfBirth: "1981-01-13",
    telephoneNumber:"+85121212121",
    billingAddress: {
        city:"Sydney",
        country:"AU",
        houseNumberOrName:"123",
        postalCode:"2000",
        stateOrProvince:"NSW",
        street:"Happy Street"
    },
    lineItems: [
       {
          description":"Shoes",
          quantity:"1",
          amountIncludingTax:"400",
          id:"Item #1"
       },
       {
          description:"Socks",
          quantity:"2",
          amountIncludingTax:"300",
          id:"Item #2"
       }
    ]
}).then(res => res);

The /payments response contains an action object with type:redirect.

/payments response
{
  "resultCode": "RedirectShopper",
  "action": {
    "method": "GET",
    "paymentData": "Ab02b4c0!BQABAgCSZT7t...",
    "paymentMethodType": "zip",
    "type": "redirect",
    "url": "https://test.adyen.com/hpp/redirect.shtml?brandCode=.."
  },
  "details": [
    {
      "key": "payload",
      "type": "text"
    }
  ],
  ...
}

If your integration is set up correctly, the action object is passed from your server to the client, and the action.paymentData temporarily stored on your server.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

  1. Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:
    checkout.createFromAction(action).mount('#my-container');
    The Component redirects the shopper to Zip to complete the payment.
  2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
    • paymentData: The value from the /payments response.
    • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your site. For example, payload or redirectResult.
    The parameters can vary based on the payment method configuration. To check which parameters you should submit, always check the details array from the /payments response.
    /payments/details request
    {
          "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
          "details":{
            "{hint:Verify the parameters from /payments response}payload{/hint}":"Ab02b4c0!BQABAgCW5sxB4e/=="
          }
    }
    The /payments/details response contains:
    • resultCode: Use this to present the payment result to your shopper.
    • pspReference: Our unique identifier for the transaction.
    /payments/details response
    {
          "resultCode": "Authorised",
          "pspReference": "88154795347618C"
    }

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for Zip are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment while on Zip's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Pending or
Received
The shopper has completed the payment but the final result is not yet known. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION notification.
Refused The payment was refused by Zip. Ask the shopper to try the payment again using a different payment method.

If the shopper closed the browser and failed to return to your website or app, wait for notification webhooks to know the outcome of the payment. The notification webhooks you can receive for Zip are:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.
OFFER_CLOSED true The shopper did not complete the payment. Cancel the order and inform the shopper that the payment timed out.

Recurring payments

We support recurring transactions for Zip. To make recurring payments, you need to:

  1. Create a shopper token.
  2. Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

  • storePaymentMethod: true
  • shopperReference: Your unique identifier for the shopper.

When the payment has been settled, you receive a webhook notification containing:

  • eventCode: RECURRING_CONTRACT
  • originalReference: The pspReference of the initial payment.
  • pspReference: This is the token that you need to make recurring payments for this shopper.
Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard notifications. If you have not requested for this additional configuration yet, contact our Support Team.

Make a payment with a token

To make a payment with the token, include in your /payments request:

  • paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT.
    You can also get this value by using the /listRecurringDetails endpoint.
  • shopperReference: The unique shopper identifier that you specified when creating the token.
  • shopperInteractionContAuth.
  • recurringProcessingModel: Subscription or UnscheduledCardOnFile.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Recurring transaction types.

curl https://checkout-test.adyen.com/v65/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
       "amount":{
          "value":1000,
          "currency":"AUD"
       },
       "paymentMethod":{
          "type":"zip",
          "storedPaymentMethodId":"7219687191761347"
       },
       "reference":"YOUR_ORDER_NUMBER",
       "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
       "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
       "shopperInteraction":"ContAuth",
       "recurringProcessingModel": "Subscription"
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "AUD",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "zip",
    :storedPaymentMethodId => "7219687191761347"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :shopperReference => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :shopperInteraction => "ContAuth",
  :recurringProcessingModel => "Subscription"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

PaymentsRequest paymentsRequest = new PaymentsRequest();

String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
paymentsRequest.setMerchantAccount(merchantAccount);

Amount amount = new Amount();
amount.setCurrency("AUD");
amount.setValue(15000L);
paymentsRequest.setAmount(amount);

DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.setRecurringDetailReference("7219687191761347");
paymentMethodDetails.setType("zip");
paymentsRequest.setPaymentMethod(paymentMethodDetails);

paymentsRequest.setReference("YOUR_ORDER_NUMBER");
paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
paymentsRequest.setShopperInteraction("ContAuth");
paymentsRequest.setRecurringProcessingModel("Subscription");

PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "AUD",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "zip",
    "storedPaymentMethodId" => "7219687191761347"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  "recurringProcessingModel" => "Subscription",
  "shopperInteraction" => "ContAuth",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'AUD'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'zip',
      'storedPaymentMethodId': '7219687191761347'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j'
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
   'shopperInteraction':'ContAuth',
   'recurringProcessingModel': 'Subscription'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("AUD", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "zip",
  StoredPaymentMethodId = "7219687191761347"
};
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  ShopperReference = "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  RecurringProcessingModel = "Subscription",
  ShopperInteraction = "ContAuth",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "AUD", value: 1000 },
    paymentMethod: {
        type: 'zip',
        storedPaymentMethodId: "7219687191761347"
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
    shopperInteraction: "ContAuth",
    recurringProcessingModel: "Subscription"
}).then(res => res);

Test and go live

Create Zip test accounts using the credentials on Zip's test credentials page. You can then use your test account to make a payment in the test environment.

Check the status of Zip test payments in your Customer Area > Transactions > Payments.

Before you can accept live Zip payments, you need to submit a request for Zip in your live Customer Area.

See also