Skip to content

Event API (v2)

Download OpenAPI description
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/eventapi/

Events

APIs to create and manage events.

Operations

Get event summaries

Request

View summaries of specific events. This endpoint retrieves a list of traveler event summaries based on specified userId, companyId, and tripIds.

Security
Bearer
Bodyapplication/jsonrequired
userIdobject(UserId)
companyIdobject(CompanyId)
tripIdsArray of strings

List of Spotnana trip IDs

Example: ["6926658168"]
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/summaries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "companyId": {
      "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
    },
    "tripIds": [
      "6926658168"
    ]
  }'

Responses

OK

Bodyapplication/json
tripEventSummariesArray of objects(TripEventSummary)

List of Event summaries for trips

Response
application/json
{ "tripEventSummaries": [ {} ] }

Get allowed payment sources

Request

Get the payment sources that are associated with the userId of the event coordinator.

Security
Bearer
Query
userIdstring(uuid)required

ID of the event coordinator

Example: userId=f49d00fe-1eda-4304-ba79-a980f565281d
curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/events/payment-sources?userId=f49d00fe-1eda-4304-ba79-a980f565281d' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
paymentSourcesArray of objects(PaymentSourceInfo)required

List of payment sources

paymentSources[].​idstring(uuid)required

Unique identifier identifying this payment source

Example: "f49d00fe-1eda-4304-ba79-a980f565281d"
paymentSources[].​typestring(PaymentSourceType)
Enum"CARD""VIRTUAL_CARD""REWARDS_PROGRAM""DELAYED_INVOICING""CUSTOM_PAYMENT_METHOD""VENDOR_PROGRAM_PAYMENT""UNUSED_CREDIT""CASH"
paymentSources[].​paymentSourceCardDescriptorWrapper (object) or RewardsProgramDescriptorWrapper (object) or VirtualCardDescriptorWrapper (object) or CustomPaymentMethodDescriptorWrapper (object) or VendorProgramPaymentDescriptorWrapper (object) or DelayedInvoicingDescriptorWrapper (object) or UnusedCreditDescriptorWrapper (object) or CashDescriptorWrapper (object)(PaymentSourceDescriptor)required
One of:

Payment source descriptor.

paymentSources[].​paymentSource.​cardDescriptorobject(CardMetadata)

Descriptor for card payment source.

paymentSources[].​statusstring(PaymentSourceStatus)read-only
Enum"ACTIVE""INCOMPLETE""TEMPORARY_READY""TEMPORARY_USED""TEMPORARY_EXPIRED""TEMPORARY_INCOMPLETE"
paymentSources[].​mappingobject(PaymentSourceMapping)Deprecated
Response
application/json
{ "paymentSources": [ {} ] }

Cancel event

Request

Cancel a published event. After you've canceled the event, it's recommended that you cancel the bookings using the Cancel PNR API.

Security
Bearer
Path
eventIdstringrequired

Event ID

Example: 6926658168
Query
typestring(EventType)

EventType of the event.

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
Example: type=GENERIC
curl -i -X POST \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168/cancel?type=GENERIC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Response
No content