Get checkout session
Returns checkout session status and details.
curl -X GET "https://api.example.com/api/v1/sessions/example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)"
import requests
import json
url = "https://api.example.com/api/v1/sessions/example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.example.com/api/v1/sessions/example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.example.com/api/v1/sessions/example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.example.com/api/v1/sessions/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
response = http.request(request)
puts response.body
{
"id": "e4b8c1a2-1234-5678-abcd-ef1234567890",
"orderReference": "ORD-12345",
"status": "PENDING",
"failureReason": "EXPIRED",
"providerName": "stripe",
"paymentMethod": "card",
"expiresAt": "2024-01-15T12:00:00.000Z",
"createdAt": "2024-01-15T11:00:00.000Z",
"updatedAt": "2024-01-15T11:30:00.000Z",
"refunds": [
{
"id": "3d72f30c-2977-44bf-b2e8-ff09b9b3216d",
"amount": 45.01,
"currency": "USD",
"status": "PENDING",
"failureReason": "LOST_OR_STOLEN_CARD",
"reason": "REQUESTED_BY_CUSTOMER",
"createdAt": "2024-01-15T11:00:00.000Z",
"updatedAt": "2024-01-15T11:30:00.000Z"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
{
"error": "Error",
"message": "Service temporarily unavailable.",
"code": 502
}
{
"error": "Error",
"message": "Request timed out.",
"code": 504
}
GET
/api/v1/sessions/{sessionId}GET
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token (JWT)
Bearer Tokenstring
RequiredBearer token (JWT) - just enter the token, "Bearer" prefix will be added automatically
path
sessionIdstring
RequiredCheckout session identifier.
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token (JWT). Authentication token required.
Path Parameters
sessionIdstring
RequiredCheckout session identifier.
Responses
idstring
RequiredorderReferencestring
Requiredstatusstring
RequiredAllowed values:
PENDINGSUCCEEDEDFAILEDfailureReasonobject
providerNameobject
paymentMethodstring
RequiredexpiresAtobject
createdAtstring
RequiredupdatedAtstring
Requiredrefundsarray
Associated refund records. Populated when the session is in SUCCEEDED, PARTIALLY_REFUNDED, REFUNDED, or REVERSED status. Null otherwise.
Was this page helpful?