Skip to main content
GET
/
v1
/
terminal
/
sessions
List Terminal Payment Sessions
curl --request GET \
  --url https://terminal-dev.xendit.co/v1/terminal/sessions \
  --header 'Authorization: Basic <encoded-value>'
{
  "has_more": false,
  "data": [
    {
      "payment_session_id": "<string>",
      "latest_payment_id": "<string>",
      "business_id": "<string>",
      "reference_id": "ref_123456789",
      "session_type": "PAY",
      "currency": "IDR",
      "amount": 2,
      "country": "ID",
      "mode": "TERMINAL",
      "status": "ACTIVE",
      "channel_properties": {
        "terminal_id": "abcd-3254fsd-3242",
        "order_id": "order-12345",
        "payment_methods": [
          "ID_INSERT_CARD"
        ]
      },
      "created": "2024-11-06T15:32:42Z",
      "updated": "2024-11-06T15:32:42Z",
      "customer_id": "cus_123456789",
      "description": "Payment for order #123",
      "metadata": {},
      "canceled_at": "2023-11-07T05:31:56Z"
    }
  ],
  "links": [
    {
      "rel": "next",
      "href": "/v1/terminal/sessions?reference_id=ref_123456789&after_id=00000000-0000-0000-0000-000000000000",
      "method": "GET"
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

reference_id
string
required

Filter sessions by reference ID

limit
integer
default:10

Maximum number of sessions to return

Required range: 1 <= x <= 100
after_id
string

Cursor for forward pagination

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
before_id
string

Cursor for backward pagination

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Response

Terminal Payment Sessions fetched successfully

has_more
boolean
required
Example:

false

data
object[]
required