Checkout

Overview

Checkout Pages enable your organization to sell carbon removal to your customers by creating your own storefront in a less than a minute.

Each Checkout page is a mini-storefront. You choose the project and quantity. Visitors to the page will be asked for their credit card information and Patch handles the entire payment flow for you, and sends a receipt to the end-buyer.

To create a new Checkout or view existing ones, visit the Checkout page in the Dashboard. Checkout pages that you create are available through a unique Patch hosted link which is publicly accessible by anyone on the internet.

Billing

Your end-users will be asked for their email and credit card information. Patch does not store the credit card information, which is sent directly to our payment provider in PCI-compliant fashion. The email address will be used exclusively to send the buyer an order receipt.

Orders placed through Checkout pages will be shown on the Orders page in your dashboard. Unlike orders placed through the API (or the dashboard), Checkout Orders will not be added to your monthly invoice, as they've already been paid for by your end users.

Languages supported

All checkout pages can be translated by passing the locale= parameter in the URL. For example https://checkout.patch.io/che_prod_6fe042a07ea74b8060e1f344540bcf81?locale=fr will automatically show the page in French.

This is usually best used in combination with the currency parameter (see below): https://checkout.patch.io/che_prod_6fe042a07ea74b8060e1f344540bcf81?locale=fr&currency=eur

We currently support the following locales: en, fr, it, ja.

Currencies supported

Checkout currently supports payments in the following currencies: USD, EUR, GBP, CAD, AUD, PLN, DKK, SEK, CZK, CHF, HUF, JPY.

See Amount Configuration via Query Parameters below for instructions on how to set the currency.

Payment methods supported

We support multiple payment methods for checkout. The payment methods available depend on the currency, and the device the end-user is browsing from.

Cards

We support payment by card in most local and global card networks.

Mobile payments

Note: if you want to embed the checkout page in your mobile app, please make sure you use a method that is compatible with Apple Pay 1 2. Notably, react-native-webview is not compatible.

Amount Configuration

When creating a checkout page, you can either:

• Specify an amount (of CO₂) to be purchased. A visitor on that checkout page can only purchase this amount.
• If you don't specify an amount, the end user will be prompted to select the mass (or dollar amount) they would like to purchase.

Amount and Price Configuration via Query Parameters

You can also configure a Checkout by passing configuration options as Query Parameters in the URL:

• You can pass either amount or total_price, but not both.
• total_price can only be used on pages set to "User Input > Price"
• amount can only be used on pages set to "User Input > Amount"
• total_price needs to be in the smallest currency unit for the selected currency. For USD, total_price=100 means 100 cents (or $1).
• A currency param can be sent to view the price in another currency. If omitted, the page defaults to usd.
• If the Checkout has a fixed amount, the currency query parameter will be ignored.

Examples:

• https://checkout.patch.io/che_prod_6fe042a07ea74b8060e1f344540bcf81?total_price=2500, will set the total price of the order (cost of the offset + patch fee) to $25.
• https://checkout.patch.io/che_prod_6fe042a07ea74b8060e1f344540bcf81?total_price=500&currency=eur, will set the total price of the order (cost of the offset + patch fee) to 25€.
• https://checkout.patch.io/che_prod_34de660a7dee72347d03083fe6ebc81d?amount=500000, will set the total amount of the order to 500kg.

Project Configuration via Query Parameters

You also have the option to set-up the project dynamically. To do so:

• Choose the "User input" option in the "Project selection" section
• Pass the project_id query parameter in the URL. For example: https://checkout.patch.io/che_prod_3fbdf255f5f93931819d479e0dd6b8d4?project_id=pro_prod_3e38a706d2ffbeac0b97d64050f34c1a.
• If the project_id is invalid, the page will show a brief notice and use to a default project.
• If the Checkout has a fixed project, the project_id query parameter will be ignored.

Subscriptions via Query Parameters

We support monthly and yearly subscriptions for all checkout purchases.

When sending a user to a checkout link you can pass the recurring_interval query param with value monthly for a monthly subscription or yearly for a yearly subscription.

If this query parameter is not passed or is passed with some other value then no subscription will be created and this will be a one-time purchase.

Example:

• https://checkout.patch.io/che_prod_6fe042a07ea74b8060e1f344540bcf81?total_price=2500&recurring_interval=monthly

User Email via Query Parameters

When sending a user to a checkout link you can also optionally send their email via the email query param, which will pre-fill the email input in the checkout form.

Example:

• https://checkout.patch.io/che_prod_6fe042a07ea74b8060e1f344540bcf81?total_price=2500&email=name%40email.com, will pre-fill name@email.com in the email input.

Redirect URLs

When creating a Checkout, you can define a "success URL" and a "fallback URL", where your users will be redirected in case of success or failure.

The following parameters will be appended to the URL you defined:

• metadata (see below)
• order_id

Appending Metadata

Metadata may be added to the order by appending metadata query parameters to the checkout URL.

For example: https://checkout.patch.io/che_prod_6fe042a07ea74b8060e1f344540bcf81?metadata[user_id]=15&metadata[tracking_number]=45

The metadata is:

• saved on the order (for future retrieval)
• forwarded as query parameters to your checkout redirect urls.

For example, assuming your success URL is https://your.website.com/success, the checkout will redirect to https://your.website.com/success?metadata%5Buser_id%5D%3D15%26metadata%5Btracking_number%5D%3D45 upon success. (Note that the initial query parameters get URL encoded)

To learn more about metadata and how it can be attached via the API, see Create Order with Metadata.

Checkout Limits

A single checkout order cannot exceed whichever is less:

• 2000 tonnes
• The remaining inventory for the associated project