Retrieve a checkout session - Equals Documentation

GET

roqqett

checkout-sessions

{checkoutSessionId}

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$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.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}"

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

	req.Header.Add("Authorization", "<api-key>")

	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.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "type": "SHOPPING",
  "status": "OPEN",
  "checkoutId": "6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12",
  "merchantReference": "ORDER-10421",
  "description": "Order ORDER-10421",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "payeeId": "d2a7c9e1-5b3f-4a8d-9e6c-1f0b2a4c8e57",
  "basket": {
    "items": [
      {
        "name": "Linen shirt",
        "description": "Size M, blue",
        "quantity": 2,
        "unitPrice": {
          "amount": "10000.00",
          "currencyCode": "GBP"
        },
        "imageUrl": "https://shop.example.com/images/shirt.png"
      }
    ]
  },
  "shipping": {
    "amount": {
      "amount": "10000.00",
      "currencyCode": "GBP"
    },
    "address": {
      "streetName": "Upper Thames Street",
      "buildingNumber": "68",
      "buildingName": "Vintners Place",
      "postcode": "EC4V 3BJ",
      "city": "London",
      "region": "Greater London",
      "countryCode": "GB"
    }
  },
  "locale": "en-GB",
  "checkoutUrl": "https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "returnUrl": "https://shop.example.com/checkout/complete",
  "paymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
  "orderId": "7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78",
  "expiresAt": "2026-10-02T13:00:00Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

checkoutSessionId

string<uuid>

required

The ID of a checkout session: one payment journey.

Maximum string length: 36

Example:

"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

Response

string<uuid>

required

The ID of a checkout session: one payment journey.

Maximum string length: 36

Example:

"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"

type

enum<string>

required

SHOPPING pays for a basket into the merchant's settlement account. TOP_UP pays into a payee the merchant supplies.

Available options:

SHOPPING,

TOP_UP

Example:

"SHOPPING"

status

enum<string>

required

OPEN until the payer authorises at their bank, PROCESSING while the payment settles, then exactly one terminal status.

Available options:

OPEN,

PROCESSING,

COMPLETED,

CANCELLED,

ABANDONED,

EXPIRED

Example:

"OPEN"

checkoutId

string<uuid>

required

The ID of a checkout: the configured payment page a checkout session is taken on.

Maximum string length: 36

Example:

"6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"

merchantReference

string

required

The merchant's own reference for this checkout session, such as its order or basket ID. Shown to the merchant, never to the payer's bank.

Required string length: 1 - 128

Example:

"ORDER-10421"

description

string | null

required

What the payment is for, as shown to the payer.

Maximum string length: 140

Example:

"Order ORDER-10421"

amount

object

required

The total the payer pays, including any shipping.

Show child attributes

payeeId

string<uuid> | null

required

The payee a TOP_UP session pays into. null for SHOPPING.

Maximum string length: 36

Example:

"d2a7c9e1-5b3f-4a8d-9e6c-1f0b2a4c8e57"

basket

object | null

required

Show child attributes

shipping

object | null

required

Show child attributes

locale

string | null

required

The locale the checkout is presented in. null when neither the request nor the checkout set one, in which case the payer's browser preference decides and en-GB is the final fallback.

Pattern: ^[a-zA-Z]{2,3}(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|\d{3}))?$

Example:

"en-GB"

checkoutUrl

string<uri>

required

Where to send the payer to pay. Valid until expiresAt.

Maximum string length: 2048

Example:

"https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"

returnUrl

string<uri> | null

required

Where the payer is sent once the session ends.

Maximum string length: 2048

Example:

"https://shop.example.com/checkout/complete"

paymentId

string<uuid> | null

required

The payment, once the payer has authorised one.

Maximum string length: 36

Example:

"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"

orderId

string<uuid> | null

required

The order a completed SHOPPING session produced. Always null for TOP_UP.

Maximum string length: 36

Example:

"7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78"

expiresAt

string<date-time>

required

When an OPEN session expires.

Example:

"2026-10-02T13:00:00Z"

createdAt

string<date-time>

required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAt

string<date-time>

required

The date the Resource was last modified. ISO 8601 format without milliseconds.

⌘I

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$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.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}"

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

	req.Header.Add("Authorization", "<api-key>")

	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.equalsmoney.com/v2/roqqett/checkout-sessions/{checkoutSessionId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "type": "SHOPPING",
  "status": "OPEN",
  "checkoutId": "6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12",
  "merchantReference": "ORDER-10421",
  "description": "Order ORDER-10421",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "payeeId": "d2a7c9e1-5b3f-4a8d-9e6c-1f0b2a4c8e57",
  "basket": {
    "items": [
      {
        "name": "Linen shirt",
        "description": "Size M, blue",
        "quantity": 2,
        "unitPrice": {
          "amount": "10000.00",
          "currencyCode": "GBP"
        },
        "imageUrl": "https://shop.example.com/images/shirt.png"
      }
    ]
  },
  "shipping": {
    "amount": {
      "amount": "10000.00",
      "currencyCode": "GBP"
    },
    "address": {
      "streetName": "Upper Thames Street",
      "buildingNumber": "68",
      "buildingName": "Vintners Place",
      "postcode": "EC4V 3BJ",
      "city": "London",
      "region": "Greater London",
      "countryCode": "GB"
    }
  },
  "locale": "en-GB",
  "checkoutUrl": "https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "returnUrl": "https://shop.example.com/checkout/complete",
  "paymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
  "orderId": "7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78",
  "expiresAt": "2026-10-02T13:00:00Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}