Payment Session Details

Get payment session details

curl --request GET \
  --url https://api-beta.pepay.io/api/v1/payments/session-details \
  --header 'x-session-token: <api-key>' \
  --header 'x-signature: <api-key>'

import requests

url = "https://api-beta.pepay.io/api/v1/payments/session-details"

headers = {
    "x-session-token": "<api-key>",
    "x-signature": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-session-token': '<api-key>', 'x-signature': '<api-key>'}
};

fetch('https://api-beta.pepay.io/api/v1/payments/session-details', 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-beta.pepay.io/api/v1/payments/session-details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-session-token: <api-key>",
    "x-signature: <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-beta.pepay.io/api/v1/payments/session-details"

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

	req.Header.Add("x-session-token", "<api-key>")
	req.Header.Add("x-signature", "<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-beta.pepay.io/api/v1/payments/session-details")

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

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

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

{
  "invoice_id": "550e8400-e29b-41d4-a716-446655440000",
  "amount_usd": 100,
  "description": "Premium subscription",
  "expires_at": 1704110400,
  "invoice_status": "unpaid",
  "remaining_time": 3600000,
  "remaining_seconds": 3600,
  "amount_remaining_usd": 100,
  "merchant_name": "Acme Corp",
  "merchant_email": "payments@acme.com",
  "network_environment": "mainnet",
  "locked_network": null,
  "locked_token_id": null,
  "locked_payment_address": null
}

GET

api

payments

session-details

Get payment session details

curl --request GET \
  --url https://api-beta.pepay.io/api/v1/payments/session-details \
  --header 'x-session-token: <api-key>' \
  --header 'x-signature: <api-key>'

import requests

url = "https://api-beta.pepay.io/api/v1/payments/session-details"

headers = {
    "x-session-token": "<api-key>",
    "x-signature": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-session-token': '<api-key>', 'x-signature': '<api-key>'}
};

fetch('https://api-beta.pepay.io/api/v1/payments/session-details', 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-beta.pepay.io/api/v1/payments/session-details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-session-token: <api-key>",
    "x-signature: <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-beta.pepay.io/api/v1/payments/session-details"

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

	req.Header.Add("x-session-token", "<api-key>")
	req.Header.Add("x-signature", "<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-beta.pepay.io/api/v1/payments/session-details")

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

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

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

{
  "invoice_id": "550e8400-e29b-41d4-a716-446655440000",
  "amount_usd": 100,
  "description": "Premium subscription",
  "expires_at": 1704110400,
  "invoice_status": "unpaid",
  "remaining_time": 3600000,
  "remaining_seconds": 3600,
  "amount_remaining_usd": 100,
  "merchant_name": "Acme Corp",
  "merchant_email": "payments@acme.com",
  "network_environment": "mainnet",
  "locked_network": null,
  "locked_token_id": null,
  "locked_payment_address": null
}

Overview

Use this endpoint in a browser/client checkout to fetch the session’s invoice context (amount, addresses, supported tokens, and more).

Authentication

Payment session endpoints require x-session-token + x-signature (browser-safe auth).

Request

SDK

const session = await pepay.paymentSessions.getSessionDetails();

cURL

curl "https://api-beta.pepay.io/api/v1/payments/session-details" \
  -H "x-session-token: pst_..." \
  -H "x-signature: sig_..."

Response

{
  "invoice_id": "550e8400-e29b-41d4-a716-446655440000",
  "amount_usd": 49.99,
  "description": "Starter plan",
  "expires_at": 1766322000,
  "invoice_status": "unpaid",
  "remaining_time": 3600000,
  "remaining_seconds": 3600,
  "merchant_name": "Pepay Demo Merchant",
  "merchant_email": "billing@example.com",
  "network_environment": "devnet"
}

Notes:

remaining_time is milliseconds until expiration (clamped at 0).
remaining_seconds is seconds until expiration (clamped at 0).

Errors

401 invalid session token/signature
404 session not found / expired

Examples

Render a checkout UI by combining session details + available tokens + payment addresses.

Next: Payment status

Authorizations

x-session-token

string

header

required

Payment session token (opaque). Returned when creating an invoice; send on every request.

x-signature

string

header

required

Payment session signature in the format signature_hash.timestamp_ms (returned with the invoice/session).

Response

Session details

invoice_id

string<uuid>

amount_usd

number

description

string | null

expires_at

integer

Session expiration timestamp (epoch seconds).

invoice_status

enum<string>

Available options:

unpaid,

underpaid,

paid,

expired,

canceled

remaining_time

number | null

Milliseconds until expiration (clamped at 0).

remaining_seconds

integer | null

Seconds until expiration (clamped at 0).

amount_remaining_usd

number | null

merchant_name

string

merchant_email

string

network_environment

enum<string>

Available options:

mainnet,

devnet

locked_network

string | null

Network locked for remaining payment when status is underpaid.

locked_token_id

integer | null

Token locked for remaining payment when status is underpaid.

locked_payment_address

string | null

Current payment address for the locked network/token (underpaid only).

Overview

API

Merchant

Tokens

Commerce

Payor

WebSockets

Webhooks

Payment Session Details

Overview

Authentication

Request

SDK

cURL

Response

Errors

Examples

Authorizations

Response

​Overview

​Authentication

​Request

​SDK

​cURL

​Response

​Errors

​Examples

Authorizations

Response

Overview

Authentication

Request

SDK

cURL

Response

Errors

Examples