--- title: "Get allowed payment sources" method: GET path: "/v2/events/payment-sources" tags: ["Events"] --- # Get allowed payment sources `GET /v2/events/payment-sources` Get the payment sources that are associated with the `userId` of the event coordinator. ## Response `200` OK - GetEventsPaymentSourcesResponse — Payment sources for events - `paymentSources` PaymentSourceInfo[], required — List of payment sources - `id` string, uuid, required — Unique identifier identifying this payment source - `type` 'CARD' | 'VIRTUAL_CARD' | 'REWARDS_PROGRAM' | 'DELAYED_INVOICING' | 'CUSTOM_PAYMENT_METHOD' | 'VENDOR_PROGRAM_PAYMENT' | 'UNUSED_CREDIT' | 'CASH' — Type of Payment Source - `paymentSource` union, required — Descriptor corresponding to the payment source. - object — Wrapper for CardDescriptor - `cardDescriptor` CardDescriptor — Descriptor for card payment source. - `card` Card, required — User card info - `id` string, uuid — Unique identifier for this card - `type` 'UNKNOWN' | 'CREDIT' | 'DEBIT' — Type of card - `company` 'NONE' | 'VISA' | 'MASTERCARD' | 'AMEX' | 'DISCOVER' | 'AIR_TRAVEL_UATP' | 'CARTE_BLANCHE' | 'DINERS_CLUB' | 'JCB' | 'BREX' | 'UNION_PAY' | 'EURO_CARD' | 'ACCESS_CARD' | 'ELO_CARD' — The issuing company of card - `name` string — Name on card - `address` PostalAddress — Postal Address Details - … - `number` string, required — Card number - `expiryMonth` integer — Expiry month - `expiryYear` integer — Expiry year - `cvv` string — Card cvv number - `label` string — Card Label - `currency` string — Native currency of the card. - `externalId` string — Spotnana partner card id. - `vaultId` string, uuid — ID of the vault used for creating the card. - `expiry` union — Contains the expiry of a Card. - … - `ownershipLabel` 'CORPORATE' | 'PERSONAL' | 'CENTRAL' — Ownership label of the card whether it is personal, corporate or central. - `isCentrallyBilled` boolean — Whether card is centrally billed or not. - `isLodgeCard` boolean — Whether card is a lodge card or not. - object — Wrapper for RewardsProgramDescriptor - `rewardsProgramDescriptor` RewardsProgramDescriptor — Descriptor for Rewards Program. - `type` 'BREX_POINTS' | 'QANTAS_POINTS' — Type of Rewards Program - object — Wrapper for VirtualCardDescriptor - `virtualCardDescriptor` VirtualCardDescriptor — Descriptor for virtual card. - `vendor` 'CONFERMA' — Type of Virtual card vendor - `reportingAttributes` ReportingAttribute[] — List of ReportingAttributes - `type` 'EMPLOYEE_ID' | 'COST_CENTER_ID' | 'LEGAL_ENTITY_ID' — Type of ReportingAttribute - `metadata` VirtualCardDescriptorMetadata — Wrapper for ConfermaMetadata - `confermaMetadata` ConfermaMetadata, required — conferma card descriptor. - … - object — Wrapper for CustomPaymentMethodDescriptor - `customPaymentMethodDescriptor` union — Metadata for Custom Payment Method payment source. - object — Wrapper for BrexBudget - `brexBudget` BrexBudget, required — Metadata for Brex Budget payment source. - … - object — Wrapper for Amadeus Checkout payment source. - `amadeusCheckout` AmadeusCheckout, required — Metadata for Amadeus Checkout payment source. - … - object — Wrapper for Qantas Travel Fund payment source. - `qantasTravelFund` QantasTravelFund, required — Metadata for Qantas Travel Fund payment source. - … - object — Wrapper for Dpan Payment Source. - `dpanMetadata` DpanMetadata, required — Metadata for DPAN payment source. - … - object — Wrapper for custom virtual payment metadata - `virtualPaymentMetadata` VirtualPaymentMetadata, required — Metadata for custom virtual payment source. - … - object — Wrapper for Flight Pass Payment Source. - `flightPassMetadata` FlightPassMetadata, required — Metadata for FlightPass payment source. - … - object — Wrapper for No Prepayment Payment Source. - `noPrepaymentMetadata` NoPrepaymentMetadata, required — Metadata for No Prepayment payment source (car bookings on no-guarantee rates). - … - object — Wrapper for VendorProgramPaymentDescriptor - `vendorProgramPaymentDescriptor` VendorProgramPaymentDescriptor — Descriptor for vendor program payment. - `vendorInfo` VendorInfo — Name/ID etc. of the vendor. - `vendorId` string, required — ID of the vendor. - `vendorName` string, required — Name of the vendor. - `vendorProgramPaymentMetadata` union, required — Vendor program payment specific metadata. - object — Wrapper for DirectBilling - … - object — Wrapper for AirlineProgram - … - object — Wrapper for DelayedInvoicing. - `delayedInvoicingDescriptor` DelayedInvoicingDescriptor — Descriptor for delayed invoicing. - `label` string, required — Label for delayed invoicing payment method - object — Wrapper for UnusedCreditDescriptor. - `unusedCreditDescriptor` UnusedCreditDescriptor — Descriptor for unused credits. - `unusedCreditInfo` UnusedCreditInfo, required — Information regarding an unused credit. - `sourcePnr` string — PNR number corresponding to third party through which booking was made. - `spotnanaPnr` string — Spotnana pnr ID. - `ticketNumber` string — Ticket number for the ticket that was converted into an unused credit. - `airlineCode` string — 2 letter airline code of the airline associated with this unused credit. - `airlineInfo` AirlineInfo - … - `totalFare` Money — Money object containing details such as the amount, the currency code, and the converted amount. - … - `issueDate` DateTimeOffset — ISO8601 UTC Date Time - … - `expiryDate` DateTimeOffset — ISO8601 UTC Date Time - … - `usedDate` DateTimeOffset — ISO8601 UTC Date Time - … - `departureDate` DateTimeOffset — ISO8601 UTC Date Time - … - `segmentsAvailable` 'UNKNOWN' | 'ALL_OPEN' | 'PARTIAL' | 'OTHER' — Whether all segments are unused or some have already been used. - `passengerName` Name — Full name containing first, middle, last (family) names, and suffix. - … - `departureCountry` string — 3 letter country code of the departure country associated with the original ticket. - `arrivalCountry` string — 3 letter country code of the arrival country associated with the original ticket. - `ticketType` 'TICKET_TYPE_UNKNOWN' | 'ETICKET' | 'MCO' | 'NON_GDS' — Type of credit. - `pcc` string — PCC the credit was issued on. - `status` 'STATUS_UNKNOWN' | 'OPEN' | 'USED' | 'RESERVED' — Status of the credit. - `source` 'UNKNOWN_SOURCE' | 'SABRE' | 'TRAVEL_FUSION' | 'AVIA' | 'NDC' | 'TRAINLINE' | 'ATPCO_NDC' | 'FARELOGIX_NDC' | 'OFFLINE' | 'CONNEXUS' | 'ROUTEHAPPY' | 'AMADEUS' | 'GIATA' | 'QBR' | 'BCD' | 'QANTAS_HOTELS' | 'SOUTHWEST' | 'EXPEDIA' | 'HOTEL_HUB' | 'MARRIOTT' | 'CLEARTRIP' | 'KYTE' | 'GROUNDSPAN' | 'SABRE_NDC' | 'BOOKING_COM' | 'CARTRAWLER' | 'PREMIER_INN' | 'TRAVELODGE' | 'ENTERPRISE' | 'HYATT' | 'EUROSTAR' | 'NATIONAL' | 'ALAMO' | 'AVIS' | 'BUDGET' | 'HERTZ' | 'DOLLAR' | 'THRIFTY' | 'FIREFLY' - `tripId` string — Trip ID that contains the unused credit - `redeemVia` 'REDEEM_VIA_OBT' | 'CONTACT_AGENT' — Credit redemption method. If the value contains `CONTACT_AGENT`, then the agent must book the ticket and redeem the credits on behalf of the traveler. - `sourceOfTruth` 'SPOTNANA' | 'MANUAL_FORM' — The system that owns the credit. - `owningPcc` string — PCC the PNR was created on. - `paymentSourceId` string, uuid — Payment source ID associated with the credit. - `creditUsageType` 'CREDIT_USAGE_TYPE_UNKNOWN' | 'COMPANY' | 'PERSONAL' — Usage type of the credit. - `email` string — Email of the passenger owning the unused credit. - `fopInfo` UnusedCreditFop — Form of payment information associated with an unused credit. - … - `fopLabel` string — The label associated with the FOP. This value can be empty if that particular FOP does not have any label. - `exchangeInfo` UnusedCreditExchangeInfo — Exchange information for unused credits. - … - `fopCardAccessType` 'CARD_ACCESS_CENTRAL' | 'CARD_ACCESS_PERSONAL' | 'CARD_ACCESS_CORPORATE' — The card access type of the FOP associated with the unused credit. - `legalEntityName` string — The name of the legal entity associated with this unused credit. - `userId` UserId, required — User identifier - `id` string, uuid, required - `companyId` CompanyId, required — Company ID - `id` string, uuid, required - object — Wrapper for Cash Payment Source. - `cashDescriptor` CashDescriptor — Descriptor for Cash. - `label` string, required — Label for Cash payment. - `mapping` PaymentSourceMapping - `accessType` 'CENTRALISED' | 'PERSONAL' | 'APPLICATION' | 'TMC' | 'ITINERARY' | 'EVENT' | 'EVENT_TEMPLATE' — Access Type of the Payment Source being created. - `accessTypeEntityId` string — Entity ID corresponding to the Access Type being created - `filter` union — Metadata corresponding to the payment source. - object — Wrapper for LegalEntityFilter - `legalEntityFilter` LegalEntityFilter — LegalEntityFilter details. - `legalEntityIds` LegalEntityId[], required — Legal Entity id List - … - `companyId` CompanyId — Company ID - … - object — Wrapper for CompanyFilter - `companyFilter` CompanyFilter — CompanyFilter details - `companyIds` CompanyId[] — Company id List - … - `companyId` CompanyId — Company ID - … - object — Wrapper for CountryFilter - `countryFilter` CountryFilter — CountryFilter details. - `countryCodes` string[], required — country Codes List - `companyId` CompanyId, required — Company ID - … - object — Wrapper for TmcFilter - `tmcFilter` TmcFilter — TmcFilter details. - `companyId` CompanyId, required — Company ID - … - `showToTraveler` boolean — If true, this TMC payment source is shown to travelers at checkout; otherwise it is TMC-internal. - object — Wrapper for PersonalFilter - `personalFilter` PersonalFilter — TmcFilter details. - `id` UserId, required — User identifier - … - `managedTravelerAccess` ManagedTravelerPaymentAccess — Settings for sharing this payment method with managed traveler profiles. Applicable for Arranger Roles. - … - object — Wrapper for IndividualFilter - `individualFilter` IndividualFilter — IndividualFilter details. - `ids` UserId[], required — List of user id - … - `companyId` CompanyId, required — Company ID - … - object — Wrapper for CostCenterFilter - `costCenterFilter` CostCenterFilter — CostCenterFilter details. - `companyId` CompanyId, required — Company ID - … - `costCenterIds` CostCenterId[], required — List of cost center ids - … - object — Wrapper for DepartmentFilter - `departmentFilter` PaymentSourceDepartmentFilter — DepartmentFilter details. - `companyId` CompanyId, required — Company ID - … - `departmentIds` DepartmentId[], required — List of department ids - … - object — Wrapper for ItineraryFilter - `itineraryFilter` ItineraryFilter — Itinerary Filter details - `itineraryInfo` union, required — Details of the itinerary - … - object — Wrapper for EventFilter - `eventFilter` PaymentEventFilter — Payment EventFilter details. - `eventIds` string[], required — Event ids List - `companyId` CompanyId, required — Company ID - … - object — Wrapper for EventTemplateFilter - `eventTemplateFilter` PaymentEventFilter — Payment EventFilter details. - `eventIds` string[], required — Event ids List - `companyId` CompanyId, required — Company ID - … - `travelType` PaymentSourceTravelType[] — Applicable payment source travel type. - `travelType` 'AIR' | 'HOTEL' | 'CAR' | 'RAIL' | 'LIMO' | 'MISC' | 'ALL', required — Travel Type - `isRequired` boolean — Whether this is a required payment source for this travel type. - `allowPostPaidBookings` boolean — Whether post paid bookings are allowed for this travel type. - `metadata` PaymentSourceTravelTypeMetadata - `travelType` string, required — Travel Type for the metadata. For cars it's CAR. - `vendors` CarVendorBasic[] — Vendors for which the payment source is applicable. - `code` string, required — Vendor code - `name` string — Vendor name - `travelTypes` PaymentSourceTravelType[] — Applicable payment source travel types - `travelType` 'AIR' | 'HOTEL' | 'CAR' | 'RAIL' | 'LIMO' | 'MISC' | 'ALL', required — Travel Type - `isRequired` boolean — Whether this is a required payment source for this travel type. - `allowPostPaidBookings` boolean — Whether post paid bookings are allowed for this travel type. - `metadata` PaymentSourceTravelTypeMetadata - `travelType` string, required — Travel Type for the metadata. For cars it's CAR. - `vendors` CarVendorBasic[] — Vendors for which the payment source is applicable. - `code` string, required — Vendor code - `name` string — Vendor name - `spendTypes` PaymentSourceSpendType[] — Applicable spend types for payment source other than travel - `spendType` 'SERVICE_FEE', required — Spend type - `paymentSourceAttributes` PaymentSourceAttributes — Attributes applicable for the payment source. - `guestTravelAllowed` boolean — Whether guest travel is allowed. - `roleTypes` RoleType[] — Role types which have access to the payment source - `includedPersonas` Persona[] — If specified, list of traveler personas which have access to the payment source. - `excludedPersonas` Persona[] — List of traveler personas which don't have access to the payment source. - `allowedThirdPartySources` ThirdPartySource[] — List of 3rd party sources supported for the payment source. - `allowedTripTypes` TripUsageType[] — List of trip types supported for the payment source. - `priority` integer — Priority of payment source used to order while listing payment sources. Priority is a positive number. - `workerType` WorkerType[] — If specified, list of traveler worker types which have access to the payment source. - `accessTypeAttributes` AccessTypeAttributes — Attributes applicable to the payment source for specific Access Type. - `travelTypeFilter` TravelTypeFilter — Filter for selecting payment sources according to different types of travel. - `travelTypes` PaymentSourceTravelType[] — Applicable travel types for Payment Source. - `travelType` 'AIR' | 'HOTEL' | 'CAR' | 'RAIL' | 'LIMO' | 'MISC' | 'ALL', required — Travel Type - `isRequired` boolean — Whether this is a required payment source for this travel type. - `allowPostPaidBookings` boolean — Whether post paid bookings are allowed for this travel type. - `metadata` PaymentSourceTravelTypeMetadata - … - `status` 'ACTIVE' | 'INCOMPLETE' | 'TEMPORARY_READY' | 'TEMPORARY_USED' | 'TEMPORARY_EXPIRED' | 'TEMPORARY_INCOMPLETE' — Status of the Payment Source. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — The specified resource was not found. --- [API](https://skmtc.net/spotnana/apis/event-api.md) · [All operations](https://skmtc.net/spotnana/apis/event-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/event-api/revisions/13f531f73066/schema)