Refund Ticket

PUT

tickets

{id}

refund

curl --request PUT \
  --url https://channels-service-alpha.fourvenues.com/tickets/{id}/refund \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "amount": 10
}'

{
  "data": {
    "_id": "5f8d0f8b9d2b3b0017b6d8a0",
    "event_id": "5f8d0f8b9d2b3b0017b6d8a0",
    "ticket_rate_id": "5f8d0f8b9d2b3b0017b6d8a0",
    "qr_code": "ABCDE12345",
    "status": "active",
    "price": {
      "_id": "1643064796675",
      "name": "Early Bird",
      "price": 12,
      "valid_until": "2022-01-01T00:00:00.000Z",
      "quantity": 0,
      "fee_type": "percentage",
      "fee_quantity": 10,
      "includes": "1 Drink",
      "additional_info": "Only valid before 2:00 am."
    },
    "payment_currency": "EUR",
    "channel_id": "5f8d0f8b9d2b3b0017b6d8a0",
    "fees": {
      "organization": 1.1,
      "discocil": 0.7
    },
    "full_name": "John Doe",
    "phone": "1234567890",
    "email": "john.appleseed@fourvenues.com",
    "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
    }
  },
  "success": true
}

Authorizations

X-Api-Key

string

header

required

Path Parameters

integer

required

Ticket id

Body

application/json

amount

integer

Amount to refund.

Example:

10

Response

200

application/json

data

object

data._id

string

The unique identifier for a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.event_id

string

Event id of a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.ticket_rate_id

string

Ticket rate id of a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.qr_code

string

QRCode of a ticket

Example:

"ABCDE12345"

data.status

enum<string>

Status of a ticket

Available options:

processing,

active,

voided,

filled_client,

pending_payment

Example:

"active"

data.price

object

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

data.payment_currency

string

Currency of the payment

Example:

"EUR"

data.channel_id

string

Channel id of a ticket

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

data.fees

object

data.full_name

string

Full name of a ticket

Example:

"John Doe"

data.phone

string

Phone number of a ticket

Example:

"1234567890"

data.email

string

Email of a ticket

Example:

"john.appleseed@fourvenues.com"

data.gender

enum<string>

Gender of the client.

Available options:

0 = women,

1 = men

Example:

0

data.birthday

string

Birthday of a ticket

Example:

"1990-01-01"

data.address

string

Address of a ticket

Example:

"123 Main St, New York, NY 10001"

data.postal_code

string

Postal code of a ticket

Example:

"10001"

data.country_code

string

Country code of a ticket

Example:

"ES"

data.personal_document_type

enum<string>

Personal document type of a ticket

Available options:

dni,

nie,

passport,

other

Example:

"dni"

data.personal_document_number

string

Personal document number of a ticket

Example:

"1234567890"

data.answers

object[]

data.supplements

object[]

data.refunded

number

Total refunded amount of a ticket

Example:

10

data.refunded_at

string

Refunded date of a ticket

Example:

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

data.refunds

object[]

Refunds of a ticket

data.for

number

Clients that can access with this ticket

Example:

1

data.enter

number

Clients that have entered with this ticket

Example:

1

data.entry_time

string

Entry time of the clients with this ticket

Example:

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

data.total_supplements

number

Total price of the supplements

Example:

2

data.total_fees

number

Total price of the fees

Example:

1.1

data.total_price

number

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

Example:

16.1

data.warranty

object

success

boolean

Get ticket by id Get ticket by code

curl --request PUT \
  --url https://channels-service-alpha.fourvenues.com/tickets/{id}/refund \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "amount": 10
}'

{
  "data": {
    "_id": "5f8d0f8b9d2b3b0017b6d8a0",
    "event_id": "5f8d0f8b9d2b3b0017b6d8a0",
    "ticket_rate_id": "5f8d0f8b9d2b3b0017b6d8a0",
    "qr_code": "ABCDE12345",
    "status": "active",
    "price": {
      "_id": "1643064796675",
      "name": "Early Bird",
      "price": 12,
      "valid_until": "2022-01-01T00:00:00.000Z",
      "quantity": 0,
      "fee_type": "percentage",
      "fee_quantity": 10,
      "includes": "1 Drink",
      "additional_info": "Only valid before 2:00 am."
    },
    "payment_currency": "EUR",
    "channel_id": "5f8d0f8b9d2b3b0017b6d8a0",
    "fees": {
      "organization": 1.1,
      "discocil": 0.7
    },
    "full_name": "John Doe",
    "phone": "1234567890",
    "email": "john.appleseed@fourvenues.com",
    "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
    }
  },
  "success": true
}

Introduction

API Reference

Webhooks

Recipes

Authorizations

Path Parameters

Body

Response