Create a Personalized Checkout Link

Learn how to create a personalized checkout link using the API.

This API service allows you to customize a checkout link created via Zotlo and generate a user-specific link.

If you want to personalize a checkout link created via the Zotlo Panel, you can customize fields such as images, texts, currency, and price to tailor the form for the end-user.

This service works with the POST method.

Method	POST
URL	https://api.zotlo.com/v2/app-to-web/one-link
Request Parameters	applicationKey: The unique key provided for the project. Available under Zotlo Panel > Developer Tools > Checkout SDK. subscriberIpAddress : IP address of the subscriber at the time of the transaction. language: Preferred language of the user. Default can be set to EN. checkoutLinkId: ID of the checkout link to be customized. A checkout link must first be created in the Zotlo Panel.

Example Request

You can find your Access Key, Access Secret, and App ID under Developer Tools > API Keys in the Zotlo Panel.

The applicationKey value can be found under Developer Tools > Checkout SDK.

{
  "applicationKey": "989e9bc1fbbbc1b82e18548c4577ed3f24c9dc39cc416db5",
  "subscriberId": "",
  "subscriberIpAddress": "37.24.56.13",
  "language": "en",
  "productImage": "",
  "additionalText": "Zotlo Test",
  "checkoutLinkId": "123",
  "packageName": "Package Name Test",
  "customPrice": "",
  "customCurrency": "",
  "customParameters": {
    "mmp": {
      "appsflyer_id": "id6446176688",
      "idfa": "B8292198-C43D-88B6-C0ABC8478E21"
    }
  }
}

Note: The generated checkout link is valid for 1 hour. If a successful payment is completed within this period, the same link cannot be used again.

Request Parameters

Request Parameters	Description	Required
applicationKey	The unique key provided for the project. Available under Zotlo Panel > Developer Tools > Checkout SDK.	✔
subscriberId	This is a unique identifier used to represent the subscriber. It can be in the format of a phone number, email address, Apple Relay email, or UUID v4. If the value is provided as an Apple Relay email or UUID v4, then an email field will be required in the form.	✖
subscriberIpAddress	IP address of the subscriber at the time of the transaction.	✔
language	Preferred language of the user. Default can be set to EN.	✔
productImage	Image URL representing the product/package. Hidden if left empty.	✖
additionalText	This is an additional information field displayed to the user. The associated price for this field is set to 0.00 by default. It is typically used to display bonus or discount messages. If left empty, this field will be hidden from the form	✖
checkoutLinkId	ID of the checkout link to be customized. A checkout link must first be created in the Zotlo Panel.	✔
packageName	Name of the package shown to the user. Hidden if left empty.	✖
customPrice	This is the special price information displayed to the user. It can override the package price for one-time payments only. If left empty, the package price will be shown based on the user’s IP address.	✖
customCurrency	Currency to be shown. If left empty, the price is displayed based on the user's IP.	✖
customParameters	Application- or user-specific parameters can be sent here. If Zotlo is sending events for Adjust or Appsflyer, the following fields can be sent with the mmp parameter.. "mmp": { "appsflyer_id": "", "oaid": "", "androidId": "", "gpsAdid": "", "idfv": "", "fireAdid": "", "adid": "", "idfa": "", "osVersion": "" }	✖

Successful Response Example

{
    "meta": {
        "requestId": "68b5fbdd6f-hpwjc-REQ-683dbb1c4c569",
        "httpStatus": 200
    },
    "result": {
        "oneLink": "https://checkout.zotlo.com/payment/6e7ac760800a071338d6b81b9dc65b9ffbbdd18de17e4cb9a1"
    }
}

Failed Response Example

Our services return HTTP status code 200 for successful responses. For unsuccessful cases, HTTP status codes 400 or 500 are returned. An example error response is as follows:

{
    "meta": {
        "requestId": "core-backend-68b5fbdd6f-hpwjc-REQ-683dc0ef3d027",
        "httpStatus": 400,
        "errorMessage": "The checkoutLinkId is required.",
        "errorCode": "400079"
    },
    "result": []
}

Failed Response Parameters

Parameter	Description
requestId	It is the unique request parameter generated and stored by Zotlo for your transaction.
httpStatus	It is the HTTP status code related to the response. The standard codes 400 or 500 are returned.
errorMessage	It is the detail of the received error. The error message is provided in the language specific to the parameter you sent.
errorCode	It is the error code from Zotlo.
result	The values this field can take are variable.If there’s an error, it will include data; otherwise, it will return as an empty object.