Retrieve a checkout

curl --request GET \
  --url https://api.taberna.io/v1/checkouts/{id}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taberna.io/v1/checkouts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taberna.io/v1/checkouts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.taberna.io/v1/checkouts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "type": "order",
  "id": "7Kq2mVn8pRt3XwYz5Bd4L",
  "storeId": "3f1a9c2e-7b04-4d8e-9a6f-2c5b1e0d7a83",
  "status": "pending",
  "priceAmount": "49.99",
  "priceCurrency": "usd",
  "successUrl": "https://example.com/thanks",
  "cancelUrl": "https://example.com/cart",
  "expiresAt": "2026-07-29T14:30:00.000Z",
  "completedAt": "2026-07-29T14:30:00.000Z",
  "items": [
    {
      "productId": "3f1a9c2e-7b04-4d8e-9a6f-2c5b1e0d7a83",
      "title": "Nitro — 1 Month",
      "image": "https://cdn.taberna.io/products/nitro.png",
      "quantity": 2,
      "unitPrice": "49.99",
      "delivery": {
        "type": "text_pool",
        "lines": [
          "ACME-9F2K-77QX"
        ]
      }
    }
  ],
  "hasCustomerEmail": false,
  "store": {
    "id": "3f1a9c2e-7b04-4d8e-9a6f-2c5b1e0d7a83",
    "name": "Acme Digital",
    "image": "https://cdn.taberna.io/stores/acme.png",
    "enabledPaymentMethods": [
      "sol",
      "usdc_solana",
      "usdc_base"
    ],
    "requireCustomerEmail": true
  },
  "activeAttempt": {
    "status": "processing",
    "paymentMethod": "usdc_base",
    "cryptoAmount": "1250000000",
    "receivedAmount": "<string>",
    "destinationAddress": "0x8F3a1C7e5B2D9046aE71c3F8b5D2e094A6c1B8d3",
    "transactions": [
      {
        "blockchain": "base",
        "txHash": "0x3d7f2b91c4e08a5619d3fb27ac60e845912f7b3d0c6a48e152b9df3706ac81be",
        "fromAddress": "<string>",
        "amount": "1250000000",
        "blockNumber": "21847391",
        "blockTime": "2026-07-29T14:30:00.000Z"
      }
    ],
    "confirmation": {
      "state": "confirming",
      "confirmations": 3,
      "required": 12,
      "stale": false
    },
    "expiresAt": "2026-07-29T14:30:00.000Z",
    "completedAt": "2026-07-29T14:30:00.000Z"
  }
}

{
  "error": "Order not found"
}

{
  "error": "Order not found"
}

Checkout

Retrieve a checkout

The hosted checkout payload for an order or an invoice, discriminated by type. This is what the payment page polls while an attempt is live.

activeAttempt carries the locked quote, the deposit address and the confirmation progress while a quote is in flight, and is null once it lapses — the buyer picks a token again for a fresh one. An order’s per-item delivery appears only once the order is completed.

Unauthenticated: possession of the checkout id is the credential, so send no API key. The id is unguessable and every payload is redacted for a buyer audience.

GET

checkouts

{id}

Retrieve a checkout

curl --request GET \
  --url https://api.taberna.io/v1/checkouts/{id}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taberna.io/v1/checkouts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taberna.io/v1/checkouts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.taberna.io/v1/checkouts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "type": "order",
  "id": "7Kq2mVn8pRt3XwYz5Bd4L",
  "storeId": "3f1a9c2e-7b04-4d8e-9a6f-2c5b1e0d7a83",
  "status": "pending",
  "priceAmount": "49.99",
  "priceCurrency": "usd",
  "successUrl": "https://example.com/thanks",
  "cancelUrl": "https://example.com/cart",
  "expiresAt": "2026-07-29T14:30:00.000Z",
  "completedAt": "2026-07-29T14:30:00.000Z",
  "items": [
    {
      "productId": "3f1a9c2e-7b04-4d8e-9a6f-2c5b1e0d7a83",
      "title": "Nitro — 1 Month",
      "image": "https://cdn.taberna.io/products/nitro.png",
      "quantity": 2,
      "unitPrice": "49.99",
      "delivery": {
        "type": "text_pool",
        "lines": [
          "ACME-9F2K-77QX"
        ]
      }
    }
  ],
  "hasCustomerEmail": false,
  "store": {
    "id": "3f1a9c2e-7b04-4d8e-9a6f-2c5b1e0d7a83",
    "name": "Acme Digital",
    "image": "https://cdn.taberna.io/stores/acme.png",
    "enabledPaymentMethods": [
      "sol",
      "usdc_solana",
      "usdc_base"
    ],
    "requireCustomerEmail": true
  },
  "activeAttempt": {
    "status": "processing",
    "paymentMethod": "usdc_base",
    "cryptoAmount": "1250000000",
    "receivedAmount": "<string>",
    "destinationAddress": "0x8F3a1C7e5B2D9046aE71c3F8b5D2e094A6c1B8d3",
    "transactions": [
      {
        "blockchain": "base",
        "txHash": "0x3d7f2b91c4e08a5619d3fb27ac60e845912f7b3d0c6a48e152b9df3706ac81be",
        "fromAddress": "<string>",
        "amount": "1250000000",
        "blockNumber": "21847391",
        "blockTime": "2026-07-29T14:30:00.000Z"
      }
    ],
    "confirmation": {
      "state": "confirming",
      "confirmations": 3,
      "required": 12,
      "stale": false
    },
    "expiresAt": "2026-07-29T14:30:00.000Z",
    "completedAt": "2026-07-29T14:30:00.000Z"
  }
}

{
  "error": "Order not found"
}

{
  "error": "Order not found"
}

Path Parameters

string

required

The checkout to read — an order id or an invoice id. Base58 short id, 21–22 characters (never 0, O, I or l), e.g. 7Kq2mVn8pRt3XwYz5Bd4L — the value that appears in checkout and invoice links, and the one this API takes as a path id.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{21,22}$

Example:

"7Kq2mVn8pRt3XwYz5Bd4L"

Response

The checkout, tagged order or invoice.

Option 1
Option 2

The hosted checkout payload for an order.

type

string

required

Marks this payload as an order checkout.

Allowed value: "order"

string

required

The order's id. Base58 short id, 21–22 characters (never 0, O, I or l), e.g. 7Kq2mVn8pRt3XwYz5Bd4L — the value that appears in checkout and invoice links, and the one this API takes as a path id.

Example:

"7Kq2mVn8pRt3XwYz5Bd4L"

storeId

string<uuid>

required

The selling store's id. Formatted as a UUID, e.g. 3f1a9c2e-7b04-4d8e-9a6f-2c5b1e0d7a83.

Example:

"3f1a9c2e-7b04-4d8e-9a6f-2c5b1e0d7a83"

status

enum<string>

required

Where the order is in its lifecycle. pending — created, waiting for the buyer to pay. completed — paid in full; any digital delivery has been released. partial — funds arrived but fell short of the locked quote. expired — the payment window closed without full payment, and any reserved stock went back to the pool.

Available options:

pending,

completed,

partial,

expired

Example:

"pending"

priceAmount

string

required

Total the buyer owes. Decimal string in the resource's fiat currency, e.g. "49.99" — a string, never a JSON number, so no precision is lost in transit.

Example:

"49.99"

priceCurrency

enum<string>

required

The fiat currency every amount on this resource is priced in. Crypto is quoted against it at payment time.

Available options:

usd,

eur

Example:

"usd"

successUrl

string | null

required

Where to send the buyer once the order is paid. Null when the merchant set none.

Example:

"https://example.com/thanks"

cancelUrl

string | null

required

Where to send the buyer if they back out. Null when the merchant set none.

Example:

"https://example.com/cart"

expiresAt

string<date-time>

required

When the order stops accepting payment. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

"2026-07-29T14:30:00.000Z"

completedAt

string<date-time> | null

required

When the order was paid in full. Null until it is. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

"2026-07-29T14:30:00.000Z"

items

object[]

required

The products being bought.

Show child attributes

hasCustomerEmail

boolean

required

Whether a receipt email is on file. The address itself is never returned to the page.

Example:

false

store

object

required

The store the buyer is paying.

Show child attributes

activeAttempt

object | null

required

The live payment attempt — the locked quote, the deposit address and the confirmation progress. Null before the buyer picks a token and once the quote lapses.

Show child attributes

Orders

Invoices

Invoice Templates

Products

Store

Webhook Deliveries

Checkout

Retrieve a checkout

Path Parameters

Response