List

List payment sessions for the authenticated merchant with optional filters. Supports filtering by subscriptionId, customerId, status, and entityType. When subscriptionId is provided the result includes both the subscription’s own activation session (entityType=‘subscription’) and any session attached to invoices for that subscription (entityType=‘invoice’). When customerId is provided the result covers the customer’s full payment history: payment-link sessions (entityType=‘payment’), the activation sessions of the customer’s subscriptions, and the sessions of those subscriptions’ invoices.

GET /v0/paymentSessions

List

cURL

curl --request GET \
  --url https://api.paygentic.io/v0/paymentSessions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paygentic.io/v0/paymentSessions"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v0/paymentSessions', 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.paygentic.io/v0/paymentSessions",
  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: Bearer <token>"
  ],
]);

$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.paygentic.io/v0/paymentSessions"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.paygentic.io/v0/paymentSessions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/paymentSessions")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "object": "list",
  "data": [
    {
      "object": "payment_session",
      "id": "<string>",
      "entityType": "<string>",
      "entityId": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "entityLabel": "<string>",
      "merchantPaymentAccountId": "<string>",
      "providerPaymentRef": "<string>",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization · string · header · required

API key authentication

Query Parameters

merchantId · string

Merchant organization ID. Required when using an API key that is not scoped to a single merchant.

subscriptionId · string

Filter to sessions linked to this subscription (its own activation session plus all of its invoices' sessions).

customerId · string

Filter to sessions for this customer: payment-link sessions plus the activation and invoice sessions of the customer's subscriptions.

status · enum<string>

Filter by payment session status.

Available options: pending, processing, completed, failed, expired, cancelled

entityType · enum<string>

Filter by the kind of entity the session pays for.

Available options: invoice, subscription, payment, topup

limit · integer · default: 10

Number of sessions to return.

Required range: 1 <= x <= 100

offset · integer · default: 0

Number of sessions to skip.

Required range: x >= 0

Response

200

application/json

List of payment sessions

object · enum<string> · required

Available options: list

data · object[] · required

Show child attributes

pagination · object · required

Offset-based pagination response.

Show child attributes