REST API Endpoints

Currently only application/json messages are accepted.

Use basic authentication with your product ID (found in the integration details of your product) as username and your vendor API key (found in the company information) as password.

Set to PREVIEW for your test systems (no real payments or licenses are processed).

Set to LIVE for production systems that only allow real licenses.

The account ID your IAM uses to identify Yatta Checkout accounts.

A token received from the Web API onSessionChange callback. It can be optionally added here to verify the frontend session.

The product ID can be found in product details in the Vendor Portal.

Interval after which the license validity must be re-checked. Should be roughly the length of a typical user session, but can also be a timestamp in the far future. It must be rechecked at least once for each payment period (e.g., monthly).

Currently only application/json messages are accepted.

Use basic authentication with your product ID (found in the integration details of your product) as username and your vendor API key (found in the company information) as password.

Set to PREVIEW for your test systems (no real payments or licenses are processed).

Set to LIVE for production systems that only allow real licenses.

The product ID can be found in product details in the Vendor Portal.

Given API key received as part of a user request.

Set to PREVIEW for your test systems to list unpublished prices.

Set to LIVE to list the currently active prices. Once your product has been published, this shows you the prices users currently see when they select your product in Yatta Checkout.

If invalid, this defaults to LIVE.

The product ID can be found in product details in the Vendor Portal.

This parameter defines a given product's payment scheme.

Set to SUBSCRIPTION to filter prices for subscription licenses.

Set to ONE_TIME_PURCHASE to filter prices for one-time purchase licenses.

Specify the length of the selected runtime.

Select a unit from DAY, MONTH or YEAR

Select an interval: DAILY, MONTHLY or YEARLY

Currently only application/json messages are accepted.

Use basic authentication with your product ID (found in the integration details of your product) as username and your vendor API key (found in the company information) as password.

This can be defined to pass any required data through the purchase process and, after a successful purchase, to you via callback. Maximum 64 key-value pairs. Keys are strings up to 42 characters. Values can be of any kind, but must be shorter than 1024 characters when stringified.

If the user buys within a certain group context, e.g., on behalf of a company, an object can be passed through the purchase process and will be returned to you after a successful purchase via callback. The object contains an ID, i.e., a string identifying the group, and a name string for the name of the group.

On a closing, certain actions might be desired. Therefore this object can be set containing a redirectUrl string, defining the URL the user will be redirected to after closing the Checkout drop-in. If included inside the URL, any occurance of $$SESSON_TOKEN$$, will be replaced by the CheckoutSession session token.

On a successful purchase, certain actions might be desired. Therefore this object can be set containing a redirectUrl string, defining the URL the user will be redirected to after making a purchase and closing the Checkout drop-in. The onClose handling is overwritten in this case. If included inside the URL, any occurance of $$SESSON_TOKEN$$, will be replaced by the CheckoutSession session token.

The billing information object contains only optional string keys. Those are: firstName for the first name of the issued person, lastName for the last name of the issued person, organizationName for the name of the issued company, address for street and house number, address2 for additional address data, postalCode for the zip code of the city, city for the name of the city, country for the country of the billing address (ISO code), province for the province of the billing address, email for the billing email the invoice will be sent to, and vatId for the VAT number of the company or person (if located inside the European Union).