GET
/
payments
Get all payments
curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/payments \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "_id": "abcdefghi1234567890",
      "status": "pending",
      "rate_id": "abcdefghi1234567890",
      "organization_id": "abcdefghi1234567890",
      "event_id": "abcdefghi1234567890",
      "resource_type": "ticket",
      "resource_ids": [
        "abcdefghi1234567890"
      ],
      "total": {
        "amount": 20.6,
        "fees": 0.6
      },
      "send_resources": true,
      "metadata": {
        "user_id": "abcdefghi1234567890",
        "internal_id": "abcdefghi1234567890"
      },
      "currency": "EUR",
      "paid_at": "2023-12-31T00:00:00.000Z",
      "expires_at": "2024-01-01T00:00:00.000Z"
    }
  ],
  "success": true
}

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
organization_id
string

Filter the payments by organization id.

​
event_id
string

Filter the payments by event id.

​
start_date
string

Filter the payments by start date.

​
end_date
string

Filter the payments by end date.

​
limit
integer
default:50

Limit the number of payments returned.

​
offset
integer
default:0

Offset the payments returned.

Response

200
application/json

OK

The response is of type object.