Skip to main content
GET
/
v1
/
payment_sessions
List all payment sessions
curl --request GET \
  --url https://api.yorlet.com/v1/payment_sessions \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "payment_session",
      "amount": 123,
      "currency": "<string>",
      "customer": "<string>",
      "description": "<string>",
      "mode": "payment",
      "payment_method_types": [
        "<string>"
      ],
      "reporting_type": "<string>",
      "return_url": "<string>",
      "status": "paid",
      "transaction": "<string>",
      "url": "<string>",
      "account": "<string>",
      "deleted": false,
      "merchant": {
        "business_name": "<string>",
        "color": "<string>",
        "country": "<string>",
        "display_name": "<string>",
        "icon": "<string>",
        "id": "<string>",
        "support_email": "<string>",
        "support_phone": "<string>",
        "support_website": "<string>"
      },
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of payment sessions.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required