POST
/
tickets
/
checkout
curl --request POST \
  --url https://channels-service-alpha.fourvenues.com/tickets/checkout \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "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"
  },
  "ticket_rate_id": "5f8d0f8b9d2b3b0017b6d8a0",
  "tickets": [
    {
      "price_id": "1234567890",
      "qr_code": "ABCDE12345",
      "full_name": "John Doe",
      "phone": "+34666666666",
      "email": "john@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"
        }
      ],
      "warranty": true
    }
  ]
}'
{
  "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": {
          "_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
        }
      }
    ],
    "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
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

200
application/json
OK
data
object