HomeAPIGuides
Documentation
General
Introduction
API Keys
Core
Checkout
Coupons
Customers
Events
Invoices
Point of Sale
Products
Purchase Intents
Price Tables
Tickets
Ticket Transfers
Transactions
Vouchers
Data Fields
Sales Channels
Webhooks
Distribution
Distribution API
Seating
Maps
Events
Objects
Reservations
Payment
Gateways
Requests
Payment Methods
Pricing
Dynamic Pricing
JS
Seating.JS
Embed.JS
Apps
Installations
Access Control & Checkin
Scans
Access Control Devices
External Access Controls
Access Lists
Memberships
Transactions
Auth
SSO

Ticket Transfers

A Ticket Transfer represents the process of transferring a ticket from one individual (sender) to another (recipient). Recipients can either accept or reject a ticket transfer.

Endpoints

The Ticket Transfer object

Attributes

_id
Required
string

The ID of the ticket transfer.

secret
Required
string

The secret token of the ticket transfer.

ticketIds
Required
array<string>

The ID of the tickets that ticket transfer belongs to.

eventId
Required
string

The ID of the event the ticket transfer belongs to.

sellerId
Required
string

The ID of the seller that ticket transfer belongs to.

status
Required
string

The status of the ticket ticket transfer.

CREATEDREJECTEDTRANSFERREDEXPIRED
origin
Required
string

The origin of the ticket transfer.

customerstubhub
sender
Required
object

Optional Attributes

Collapse all
createdAt
Required
string date-time

An ISO Timestamp indicating when the ticket transfer was created.

updatedAt
Required
string date-time

An ISO Timestamp indicating when the ticket transfer was updated.

Optional Attributes

Collapse all
Was this section helpful?
YesNo
Example
{
  "_id": "string",
  "secret": "string",
  "ticketIds": [
    "string"
  ],
  "eventId": "string",
  "groupEventId": "string",
  "sellerId": "string",
  "status": "CREATED",
  "origin": "customer",
  "recipient": {
    "email": "[email protected]",
    "phone": "string",
    "customerId": "string"
  },
  "sender": {},
  "outcome": {
    "tickets": [
      {
        "ticketId": "string",
        "originTicketId": "string"
      }
    ]
  },
  "history": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "string",
      "type": "created"
    }
  ],
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
PUBLIC

Create Ticket Transfer

Payload

tickets
Required
array

The array of tickets to be transferred

tickets[].id
Required
string

The ID of the ticket.

tickets[].secret
Required
string

The secret of the ticket.

recipient
Required
object

The ticket transfer recipient

recipient.email
Required
string email

The email of the ticket transfer recipient.

Optional Attributes

Collapse all

Optional Attributes

Collapse all
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
post
/api/ticket-transfers
{
  "tickets": [
    {
      "id": "string",
      "secret": "string"
    }
  ],
  "childEventId": "string",
  "recipient": {
    "email": "[email protected]",
    "customerId": "string",
    "phone": "string"
  },
  "requiresAcceptance": true
}
Response
application/json
{
  "_id": "string",
  "secret": "string",
  "sender": {},
  "recipient": {
    "email": "[email protected]",
    "phone": "string",
    "customerId": "string"
  },
  "status": "CREATED",
  "outcome": {
    "tickets": [
      {
        "ticketId": "string",
        "originTicketId": "string"
      }
    ]
  },
  "eventId": "string",
  "groupEventId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "tickets": [
    {
      "id": "string",
      "ticketName": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "secret": "string",
      "email": "[email protected]",
      "name": "string",
      "excludedEventIds": [
        "string"
      ],
      "createdAt": "2030-01-23T23:00:00.123Z"
    }
  ]
}
PUBLIC

Accept Ticket Transfer

Payload

secret
Required
string

The secret of the ticket transfer.

prename
Required
string

The first name of the customer

lastname
Required
string

The last name of the customer

Optional Attributes

Collapse all
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
post
/api/ticket-transfers/{id}/accept
{
  "secret": "string",
  "prename": "string",
  "lastname": "string",
  "ticketIds": [
    "string"
  ]
}
Response
application/json
{
  "_id": "string",
  "secret": "string",
  "sender": {},
  "recipient": {
    "email": "[email protected]",
    "phone": "string",
    "customerId": "string"
  },
  "status": "CREATED",
  "outcome": {
    "tickets": [
      {
        "ticketId": "string",
        "originTicketId": "string"
      }
    ]
  },
  "eventId": "string",
  "groupEventId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "tickets": [
    {
      "id": "string",
      "ticketName": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "secret": "string",
      "email": "[email protected]",
      "name": "string",
      "excludedEventIds": [
        "string"
      ],
      "createdAt": "2030-01-23T23:00:00.123Z"
    }
  ]
}
PUBLIC

Reject Ticket Transfer

Payload

secret
Required
string

The secret of the ticket transfer.

Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
post
/api/ticket-transfers/{id}/reject
{
  "secret": "string"
}
Response
application/json
{
  "_id": "string",
  "secret": "string",
  "sender": {},
  "recipient": {
    "email": "[email protected]",
    "phone": "string",
    "customerId": "string"
  },
  "status": "CREATED",
  "outcome": {
    "tickets": [
      {
        "ticketId": "string",
        "originTicketId": "string"
      }
    ]
  },
  "eventId": "string",
  "groupEventId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "tickets": [
    {
      "id": "string",
      "ticketName": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "secret": "string",
      "email": "[email protected]",
      "name": "string",
      "excludedEventIds": [
        "string"
      ],
      "createdAt": "2030-01-23T23:00:00.123Z"
    }
  ]
}
PUBLIC

Get Public Ticket Transfer

Query

No supported query parameters
Responses
200
OK
400
Bad Request
404
Not Found

Was this section helpful?

YesNo
get
/api/ticket-transfers/{id}/{secret}
Response
application/json
{
  "_id": "string",
  "secret": "string",
  "sender": {},
  "recipient": {
    "email": "[email protected]",
    "phone": "string",
    "customerId": "string"
  },
  "status": "CREATED",
  "outcome": {
    "tickets": [
      {
        "ticketId": "string",
        "originTicketId": "string"
      }
    ]
  },
  "eventId": "string",
  "groupEventId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "tickets": [
    {
      "id": "string",
      "ticketName": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "secret": "string",
      "email": "[email protected]",
      "name": "string",
      "excludedEventIds": [
        "string"
      ],
      "createdAt": "2030-01-23T23:00:00.123Z"
    }
  ]
}

Get a Ticket Transfer

Query

No supported query parameters
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
get
/api/ticket-transfers/{id}
Response
application/json
{
  "_id": "string",
  "secret": "string",
  "ticketIds": [
    "string"
  ],
  "eventId": "string",
  "groupEventId": "string",
  "sellerId": "string",
  "status": "CREATED",
  "origin": "customer",
  "recipient": {
    "email": "[email protected]",
    "phone": "string",
    "customerId": "string"
  },
  "sender": {},
  "outcome": {
    "tickets": [
      {
        "ticketId": "string",
        "originTicketId": "string"
      }
    ]
  },
  "history": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "string",
      "type": "created"
    }
  ],
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get All Ticket Transfers

Query

ticketIds
Optional
array<string>

Tickets array for which ticket transfers are requested

status
Optional
array<string>

Filter ticket transfers by status

sender
Optional
object

Filter ticket transfers by recipient details

Optional Attributes

Collapse all
recipient
Optional
object

Filter ticket transfers by sender details

Optional Attributes

Collapse all
eventId
Optional
string

Filter ticket transfers by event id

origin
Optional
array

Filter ticket transfers by origin

One of
Only one of the following types
updatedAt
Optional
object

Range of dates indicating when the ticket transfer was last updated in ISO format.

Optional Attributes

Collapse all
top
Optional
number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip
Optional
number float

The number of objects to skip for the requested result

Responses
200
OK
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
get
/api/ticket-transfers
Response
application/json
{
  "docs": [
    {
      "_id": "string",
      "secret": "string",
      "ticketIds": [
        "string"
      ],
      "eventId": "string",
      "groupEventId": "string",
      "sellerId": "string",
      "status": "CREATED",
      "origin": "customer",
      "recipient": {
        "email": "[email protected]",
        "phone": "string",
        "customerId": "string"
      },
      "sender": {},
      "outcome": {
        "tickets": [
          {
            "ticketId": "string",
            "originTicketId": "string"
          }
        ]
      },
      "history": [
        {
          "_id": "string",
          "date": "2030-01-23T23:00:00.123Z",
          "userId": "string",
          "type": "created"
        }
      ],
      "expiresAt": "2030-01-23T23:00:00.123Z",
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "total": 1
}
PUBLIC

Get Public Ticket Transfers

Query

tickets
Optional
array

Tickets array for which status is requested

tickets[].id
Required
string

The ID of the ticket.

tickets[].secret
Required
string

The secret of the ticket.

status
Optional
string

The status of ticket transfer

CREATEDTRANSFERRED
childEventId
Optional
string

The associated event id from season. Only used for season card tickets.

customerId
Optional
string

The ID of the customer who either sender either recipient of ticket transfer.

origin
Optional
string

The origin of ticket transfer

customerstubhub
updatedAt
Optional
object

Range of dates indicating when the ticket transfer was last updated in ISO format.

Optional Attributes

Collapse all
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
get
/api/public/ticket-transfers
Response
application/json
[
  {
    "_id": "string",
    "secret": "string",
    "sender": {},
    "recipient": {
      "email": "[email protected]",
      "phone": "string",
      "customerId": "string"
    },
    "status": "CREATED",
    "outcome": {
      "tickets": [
        {
          "ticketId": "string",
          "originTicketId": "string"
        }
      ]
    },
    "eventId": "string",
    "groupEventId": "string",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "tickets": [
      {
        "id": "string",
        "ticketName": "string",
        "seatingInfo": {
          "_id": "string",
          "_type": 6,
          "categoryId": "string",
          "statusId": "string",
          "name": "string",
          "seatType": "handicapped",
          "sectionName": "string",
          "groupName": "string",
          "rowName": "string",
          "seatName": "string",
          "gate": "string"
        },
        "secret": "string",
        "email": "[email protected]",
        "name": "string",
        "excludedEventIds": [
          "string"
        ],
        "createdAt": "2030-01-23T23:00:00.123Z"
      }
    ]
  }
]