GuidesAPI Reference

Advanced Approvals

Suggest Edits

Overview

Merchants can get even more out of Zip by using the Advanced Approvals feature to increase the number of customers that will get approved for a Zip order. By sending Zip extra data points on your logged-in customers, Zip can develop advanced logic that will allow more customers to get through our identity and risk evaluations. Getting more customers approved for Zip will increase overall transaction volume.

Benefits

  • Higher total transaction volume
  • Reduced declines
  • Higher customer satisfaction

How to get signed up
Contact your Zip Account Manager (or dedicated Integrations Engineer if you are currently integrating with Zip) for more information on the signup process for Advanced Approvals. Once we have confirmed which data fields you will be sending in, we will need a trial period to model that data before we can turn on Advanced Approvals for your account.

Data Definitions

Below are the additional data fields we can accept:

📘

Not all data fields required

It is not required to send all the fields below. Even a subset of these fields provide the ability for Advanced Approvals to provide benefit.

PropertyTypeOptional/RequiredDescription
customerLoggedInbooleanOptionalIndicate whether the customer is currently logged to your site
customerIsMemberbooleanOptionalIndicate whether the customer has an account with your site
merchantRiskAssessmentstringOptionalInclude your own risk score or risk assessment on the customer
sameDevicebooleanOptionalIndicate whether the customer is using an existing device you recognize
fulfillmentMethodstringOptionalIndicate whether the order is online only, or for an in-store pickup
accountCreationDatedateOptionalDate the customer first created their account with you
lastTransactionDatedateOptionalDate the customer last made a successful purchase with you
customerTransactionCountstringOptionalTotal count of the customer’s transactions
customerAverageOrderValuestringOptionalAverage order value of all the customer’s past transitions
customerFraudIncidentsbooleanOptionalIndicate whether the customer has had any fraud incidents with you in the pas

For SMI

Although the data fields are the same, the format is slightly different for SMI integrations.

PropertyTypeOptional/RequiredDescription
customer_logged_inbooleanOptionalIndicate whether the customer is currently logged to your site
customer_is_memberbooleanOptionalIndicate whether the customer has an account with your site
merchant_risk_assessmentstringOptionalInclude your own risk score or risk assessment on the customer
same_devicebooleanOptionalIndicate whether the customer is using an existing device you recognize
fulfillment_methodstringOptionalIndicate whether the order is online only, or for an in-store pickup
account_creation_datedateOptionalDate the customer first created their account with you
last_transaction_datedateOptionalDate the customer last made a successful purchase with you
customer_transaction_countstringOptionalTotal count of the customer’s transactions
customer_average_order_valuestringOptionalAverage order value of all the customer’s past transitions
customer_fraud_incidentsbooleanOptionalIndicate whether the customer has had any fraud incidents with you in the past

How to Implement

Gateway API Integrations

Once a merchant has reached out to Zip to get signed up to implement Advanced Approvals, any of the above data points can be added to the /authorize endpoint.

To pass in data about customers, add the applicable fields into the /orders/authorize endpoint, in the additionalData object.

See the following API documentation for adding the additionalData object into your initial 'start checkout' call: /orders/authorize endpoint for Advanced Approvals.

Request Body Parameters

{
 "additionalData": {
    "customerLoggedIn": "true",
    "customerIsMember": "true",
    "merchantRiskAssessment": "3",
    "sameDevice": "true",
    "fulfillmentMethod": "in-store",
    "accountCreationDate": "2022-10-30",
    "lastTransactionDate": "2023-07-04",
    "customerTransactionCount": "3",
    "customerAverageOrderValue":"273.54", 
    "customerFraudIncidents":- "false"
   }
}

SMI API Integrations

Once a merchant has reached out to Zip to get signed up to implement Advanced Approvals, any of the above data points can be added to the /checkouts endpoint.

To pass in data about customers, add the applicable fields into the /checkouts endpoint, in the additionalData object.

See the following API documentation for adding the additional_data object into your initial 'start checkout' call: /checkouts endpoint for Advanced Approvals.

Request Body Parameters

{
  "shopper": {
 "additional_data": {
    "customer_logged_in": "true",
    "customer_is_member": "true",
    "merchant_risk_assessment": "3",
    "same_device": "true",
    "fulfillment_method": "in-store",
    "account_creation_date": "2022-10-30",
    "last_transaction_date": "2023-07-04",
    "customer_transaction_count": "3",
    "customer_average_order_value":"273.54", 
    "customer_fraud_incidents":- "false"
   }
  }   
 }

Virtual Checkout Integrations

For merchants using our Virtual Checkout solution, once a merchant has reached out to Zip to get signed up to implement Advanced Approvals, any of the above data points can be passed into the additionalData object in the onClick event.

Updated 1 day ago