Checkout tickets

curl --request POST \
  --url https://channels-service-alpha.fourvenues.com/tickets/checkout \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "ticket_rate_id": "5f8d0f8b9d2b3b0017b6d8a0",
  "tickets": [
    {
      "price_id": "1234567890",
      "qr_code": "ABCDE12345",
      "full_name": "John Doe",
      "phone": "+34666666666",
      "email": "[email protected]",
      "gender": "0",
      "birthday": "1990-01-01",
      "address": "123 Main St, New York, NY 10001",
      "postal_code": "10001",
      "country_code": "ES",
      "personal_document_type": "dni",
      "personal_document_number": "1234567890",
      "answers": [
        {
          "question_id": "1234567890",
          "answer": "Answer"
        }
      ],
      "supplements": [
        {
          "supplement_id": "1234567890"
        }
      ],
      "warranty": true
    }
  ],
  "redirect_url": "https://app.yourwebpage.com/checkout/internal-id/success",
  "error_url": "https://app.yourwebpage.com/checkout/internal-id/error",
  "send_resourcers": true,
  "metadata": {
    "key": "value"
  }
}
'

{
  "data": {
    "payment_id": "1234567890",
    "payment_url": "https://payment.yourwebpage.com/1234567890",
    "total_amount": 10,
    "tickets": [
      {
        "_id": "5f8d0f8b9d2b3b0017b6d8a0",
        "event_id": "5f8d0f8b9d2b3b0017b6d8a0",
        "ticket_rate_id": "5f8d0f8b9d2b3b0017b6d8a0",
        "qr_code": "ABCDE12345",
        "status": "active",
        "price": {
          "price": 12,
          "valid_until": "2022-01-01T00:00:00.000Z",
          "quantity": 0,
          "includes": "1 Drink",
          "additional_info": "Only valid before 2:00 am.",
          "_id": "1643064796675",
          "name": "Early Bird",
          "fee_type": "percentage",
          "fee_quantity": 10
        },
        "payment_currency": "EUR",
        "channel_id": "5f8d0f8b9d2b3b0017b6d8a0",
        "fees": {
          "organization": 1.1,
          "discocil": 0.7
        },
        "full_name": "John Doe",
        "phone": "1234567890",
        "email": "[email protected]",
        "gender": 0,
        "birthday": "1990-01-01",
        "address": "123 Main St, New York, NY 10001",
        "postal_code": "10001",
        "country_code": "ES",
        "personal_document_type": "dni",
        "personal_document_number": "1234567890",
        "answers": [
          {
            "question_id": "1234567890",
            "answer": "Answer"
          }
        ],
        "supplements": [
          {
            "supplement_id": "1234567890",
            "price": 1
          }
        ],
        "refunded": 10,
        "refunded_at": "2020-10-19T07:00:00.000Z",
        "refunds": [
          {
            "channel_id": "5f8d0f8b9d2b3b0017b6d8a0",
            "amount": 10,
            "at": "2020-10-19T07:00:00.000Z"
          }
        ],
        "for": 1,
        "enter": 1,
        "entry_time": "2022-07-19T07:00:00.000Z",
        "total_supplements": 2,
        "total_fees": 1.1,
        "total_price": 16.1,
        "warranty": {
          "total": 1,
          "hours": 12
        }
      }
    ],
    "conditions_changed": true
  }
}

POST

tickets

checkout

Checkout tickets

curl --request POST \
  --url https://channels-service-alpha.fourvenues.com/tickets/checkout \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "ticket_rate_id": "5f8d0f8b9d2b3b0017b6d8a0",
  "tickets": [
    {
      "price_id": "1234567890",
      "qr_code": "ABCDE12345",
      "full_name": "John Doe",
      "phone": "+34666666666",
      "email": "[email protected]",
      "gender": "0",
      "birthday": "1990-01-01",
      "address": "123 Main St, New York, NY 10001",
      "postal_code": "10001",
      "country_code": "ES",
      "personal_document_type": "dni",
      "personal_document_number": "1234567890",
      "answers": [
        {
          "question_id": "1234567890",
          "answer": "Answer"
        }
      ],
      "supplements": [
        {
          "supplement_id": "1234567890"
        }
      ],
      "warranty": true
    }
  ],
  "redirect_url": "https://app.yourwebpage.com/checkout/internal-id/success",
  "error_url": "https://app.yourwebpage.com/checkout/internal-id/error",
  "send_resourcers": true,
  "metadata": {
    "key": "value"
  }
}
'

{
  "data": {
    "payment_id": "1234567890",
    "payment_url": "https://payment.yourwebpage.com/1234567890",
    "total_amount": 10,
    "tickets": [
      {
        "_id": "5f8d0f8b9d2b3b0017b6d8a0",
        "event_id": "5f8d0f8b9d2b3b0017b6d8a0",
        "ticket_rate_id": "5f8d0f8b9d2b3b0017b6d8a0",
        "qr_code": "ABCDE12345",
        "status": "active",
        "price": {
          "price": 12,
          "valid_until": "2022-01-01T00:00:00.000Z",
          "quantity": 0,
          "includes": "1 Drink",
          "additional_info": "Only valid before 2:00 am.",
          "_id": "1643064796675",
          "name": "Early Bird",
          "fee_type": "percentage",
          "fee_quantity": 10
        },
        "payment_currency": "EUR",
        "channel_id": "5f8d0f8b9d2b3b0017b6d8a0",
        "fees": {
          "organization": 1.1,
          "discocil": 0.7
        },
        "full_name": "John Doe",
        "phone": "1234567890",
        "email": "[email protected]",
        "gender": 0,
        "birthday": "1990-01-01",
        "address": "123 Main St, New York, NY 10001",
        "postal_code": "10001",
        "country_code": "ES",
        "personal_document_type": "dni",
        "personal_document_number": "1234567890",
        "answers": [
          {
            "question_id": "1234567890",
            "answer": "Answer"
          }
        ],
        "supplements": [
          {
            "supplement_id": "1234567890",
            "price": 1
          }
        ],
        "refunded": 10,
        "refunded_at": "2020-10-19T07:00:00.000Z",
        "refunds": [
          {
            "channel_id": "5f8d0f8b9d2b3b0017b6d8a0",
            "amount": 10,
            "at": "2020-10-19T07:00:00.000Z"
          }
        ],
        "for": 1,
        "enter": 1,
        "entry_time": "2022-07-19T07:00:00.000Z",
        "total_supplements": 2,
        "total_fees": 1.1,
        "total_price": 16.1,
        "warranty": {
          "total": 1,
          "hours": 12
        }
      }
    ],
    "conditions_changed": true
  }
}

Authorizations

X-Api-Key

string

header

required

Body

application/json

ticket_rate_id

string

required

Ticket rate id of a ticket.

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

tickets

object[]

required

Show child attributes

tickets.price_id

string

Price id of the ticket.

Example:

"1234567890"

tickets.qr_code

string

QRCode. Optional. If not provided, it will be generated automatically.

Example:

"ABCDE12345"

tickets.full_name

string

Full name of a ticket. May be required depending on the settings of the ticket rate.

Example:

"John Doe"

tickets.phone

string

Phone number of a ticket. May be required depending on the settings of the ticket rate.

Example:

"+34666666666"

tickets.email

string

Email of a ticket. May be required depending on the settings of the ticket rate.

Example:

"[email protected]"

tickets.gender

enum<string>

Available options:

0,

1

tickets.birthday

string

Client's birthday.

Example:

"1990-01-01"

tickets.address

string

Client's address.

Example:

"123 Main St, New York, NY 10001"

tickets.postal_code

string

Client's postal code.

Example:

"10001"

tickets.country_code

string

Client's country code. (ISO3166-2)

Example:

"ES"

tickets.personal_document_type

enum<string>

Client's personal document type.

Available options:

dni,

nie,

passport,

other

Example:

"dni"

tickets.personal_document_number

string

Client's personal document number.

Example:

"1234567890"

tickets.answers

object[]

Show child attributes

tickets.answers.question_id

string

Question's identifier.

Example:

"1234567890"

tickets.answers.answer

string

Answer.

Example:

"Answer"

tickets.supplements

object[]

Show child attributes

tickets.supplements.supplement_id

string

Supplement's identifier.

Example:

"1234567890"

tickets.warranty

boolean

If the warranty is enabled.

redirect_url

string

URL to redirect the user after the checkout.

Example:

"https://app.yourwebpage.com/checkout/internal-id/success"

error_url

string

URL to redirect the user if the checkout fails.

Example:

"https://app.yourwebpage.com/checkout/internal-id/error"

send_resourcers

boolean

If the resources (tickets in that case) should be sent via email (and Whatsapp if is enabled) by Fourvenues.

Example:

true

metadata

object

Metadata to be stored in the ticket. Max 1kb.

Example:

{ "key": "value" }

Response

data

object

Show child attributes

data.payment_id

string

Payment id.

Example:

"1234567890"

data.payment_url

string

Payment URL.

Example:

"https://payment.yourwebpage.com/1234567890"

data.total_amount

number

Total amount of the payment.

Example:

10

data.tickets

object[]

Show child attributes

data.tickets._id

string

The unique identifier for a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.tickets.event_id

string

Event id of a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.tickets.ticket_rate_id

string

Ticket rate id of a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.tickets.qr_code

string

QRCode of a ticket

Example:

"ABCDE12345"

data.tickets.status

enum<string>

Status of a ticket

Available options:

processing,

active,

voided,

filled_client,

pending_payment

Example:

"active"

data.tickets.price

object

A ticket rate can have one or multiple prices but only one can be active at a time.

Show child attributes

data.tickets.price.price

number

required

Price of the ticket.

Example:

12

data.tickets.price.valid_until

string

required

Date until the price will be available.

Example:

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

data.tickets.price.quantity

number

required

Max number of tickets that can be purchased with this price.
NOTE: 0 means unlimited.

Example:

0

data.tickets.price.includes

string

required

Content the price includes.

Example:

"1 Drink"

data.tickets.price.additional_info

string

required

Additional info.

Example:

"Only valid before 2:00 am."

data.tickets.price._id

string

Unique identifier for the price.

Example:

"1643064796675"

data.tickets.price.name

string

Name of the price.

Example:

"Early Bird"

data.tickets.price.fee_type

enum<string>

Type of the fee.

Available options:

percentage,

fixed

Example:

"percentage"

data.tickets.price.fee_quantity

number

Quantity of the fee.

Example:

10

data.tickets.payment_currency

string

Currency of the payment

Example:

"EUR"

data.tickets.channel_id

string

Channel id of a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.tickets.fees

object

Show child attributes

data.tickets.fees.organization

number

Fee charged to the client by the organization

Example:

1.1

data.tickets.fees.discocil

number

Fee charged by Fourvenues to the organization

Example:

0.7

data.tickets.full_name

string

Full name of a ticket

Example:

"John Doe"

data.tickets.phone

string

Phone number of a ticket

Example:

"1234567890"

data.tickets.email

string

Email of a ticket

Example:

"[email protected]"

data.tickets.gender

enum<string>

Gender of the client.

Available options:

0 = women,

1 = men

Example:

0

data.tickets.birthday

string

Birthday of a ticket

Example:

"1990-01-01"

data.tickets.address

string

Address of a ticket

Example:

"123 Main St, New York, NY 10001"

data.tickets.postal_code

string

Postal code of a ticket

Example:

"10001"

data.tickets.country_code

string

Country code of a ticket

Example:

"ES"

data.tickets.personal_document_type

enum<string>

Personal document type of a ticket

Available options:

dni,

nie,

passport,

other

Example:

"dni"

data.tickets.personal_document_number

string

Personal document number of a ticket

Example:

"1234567890"

data.tickets.answers

object[]

Show child attributes

data.tickets.answers.question_id

string

Question id of a ticket

Example:

"1234567890"

data.tickets.answers.answer

string

Answer of a ticket

Example:

"Answer"

data.tickets.supplements

object[]

Show child attributes

data.tickets.supplements.supplement_id

string

Supplement id of a ticket

Example:

"1234567890"

data.tickets.supplements.price

number

Price of the supplement

Example:

1

data.tickets.refunded

number

Total refunded amount of a ticket

Example:

10

data.tickets.refunded_at

string

Refunded date of a ticket

Example:

"2020-10-19T07:00:00.000Z"

data.tickets.refunds

object[]

Refunds of a ticket

Show child attributes

data.tickets.refunds.channel_id

string

Channel id of a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.tickets.refunds.amount

number

Refund amount of a ticket

Example:

10

data.tickets.refunds.at

string

Refund date of a ticket

Example:

"2020-10-19T07:00:00.000Z"

data.tickets.for

number

Clients that can access with this ticket

Example:

1

data.tickets.enter

number

Clients that have entered with this ticket

Example:

1

data.tickets.entry_time

string

Entry time of the clients with this ticket

Example:

"2022-07-19T07:00:00.000Z"

data.tickets.total_supplements

number

Total price of the supplements

Example:

2

data.tickets.total_fees

number

Total price of the fees

Example:

1.1

data.tickets.total_price

number

Total price of the ticket + all extras (supplements, fees, warranty price, etc.)

Example:

16.1

data.tickets.warranty

object

Show child attributes

data.tickets.warranty.total

number

Total amount that costs the warranty.

Example:

1

data.tickets.warranty.hours

number

Hours before the event the warranty can be used.

Example:

12

data.conditions_changed

boolean

If the conditions of the ticket rate have changed. This means that the price of the ticket rate has changed and is different from the one asked by the client.

Example:

true

Create ticket Get ticket by id

⌘I

Introduction

API Reference

Webhooks

Recipes

Checkout tickets

Authorizations

Body

Response