Get all payments

GET

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

data

object[]

data._id

string

required

Unique identifier of the payment.

Example:

"abcdefghi1234567890"

data.status

string

required

Status of the payment.

Example:

"pending"

data.rate_id

string

required

Unique identifier for the ticket rate.

Example:

"abcdefghi1234567890"

data.organization_id

string

required

Unique identifier for the organization.

Example:

"abcdefghi1234567890"

data.event_id

string

required

Unique identifier for the organization.

Example:

"abcdefghi1234567890"

data.resource_type

enum<string>

required

Resource bought.

Available options:

ticket,

name-change,

list,

pass,

plan,

booking

Example:

"ticket"

data.resource_ids

string[]

required

Unique identifier for the resources.

data.total

object

required

Total payment.

Example:

{ "amount": 20.6, "fees": 0.6 }

data.currency

string

required

Currency used for total.

Example:

"EUR"

data.paid_at

string

required

Date that should be displayed as the date the payment was made.

Example:

"2023-12-31T00:00:00.000Z"

data.expires_at

string

required

Expiration date of for the payment.

Example:

"2024-01-01T00:00:00.000Z"

data.send_resources

boolean

If the resources (tickets, passes, etc) should be sent to the user (via email, sms, whatsapp, etc) by Fourvenues.

Example:

true

data.metadata

object

Metadata passed by the API client to be stored in the payment. Max 1kb.

Example:

{
  "user_id": "abcdefghi1234567890",
  "internal_id": "abcdefghi1234567890"
}

success

boolean

Get an organization by slug Get a payment by id

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
}

Introduction

API Reference

Webhooks

Recipes

Authorizations

Query Parameters

Response