# Get allowed payment sources

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

Endpoint: GET /v2/events/payment-sources
Version: v2
Security: Bearer

## Query parameters:

  - `userId` (string, required)
    ID of the event coordinator
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

## Response 200 fields (application/json):

  - `paymentSources` (array, required)
    List of payment sources

  - `paymentSources.id` (string, required)
    Unique identifier identifying this payment source
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

  - `paymentSources.type` (string)
    Type of Payment Source
    Enum: "CARD", "VIRTUAL_CARD", "REWARDS_PROGRAM", "DELAYED_INVOICING", "CUSTOM_PAYMENT_METHOD", "VENDOR_PROGRAM_PAYMENT", "UNUSED_CREDIT", "CASH"

  - `paymentSources.paymentSource` (any, required)

  - `paymentSources.status` (string)
    Status of the Payment Source.
    Enum: "ACTIVE", "INCOMPLETE", "TEMPORARY_READY", "TEMPORARY_USED", "TEMPORARY_EXPIRED", "TEMPORARY_INCOMPLETE"

  - `paymentSources.mapping` (object)
    Mapping i.e. access level, travel type information etc.

  - `paymentSources.mapping.accessType` (string)
    Access Type of the Payment Source
    Enum: "CENTRALISED", "PERSONAL", "APPLICATION", "TMC", "ITINERARY", "EVENT", "EVENT_TEMPLATE"

  - `paymentSources.mapping.accessTypeEntityId` (string)
    Entity ID corresponding to the Access Type being created

  - `paymentSources.mapping.filter` (any)

  - `paymentSources.mapping.travelTypes` (array)
    Applicable payment source travel types

  - `paymentSources.mapping.travelTypes.travelType` (string, required)
    Applicable travel segment type, e.g. AIR, HOTEL etc.
    Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL"

  - `paymentSources.mapping.travelTypes.isRequired` (boolean)
    Whether this is a required payment source for this travel type.

  - `paymentSources.mapping.travelTypes.allowPostPaidBookings` (boolean)
    Whether post paid bookings are allowed for this travel type.

  - `paymentSources.mapping.travelTypes.metadata` (any)

  - `paymentSources.mapping.spendTypes` (array)
    Applicable spend types for payment source other than travel

  - `paymentSources.mapping.spendTypes.spendType` (string, required)
    Applicable spend type e.g SERVICE_FEE
    Enum: "SERVICE_FEE"

  - `paymentSources.mapping.paymentSourceAttributes` (object)
    Attributes applicable to the associated payment source.

  - `paymentSources.mapping.paymentSourceAttributes.roleTypes` (array)
    Role types which have access to the payment source
    Enum: "UNKNOWN_TYPE", "COMPANY_ADMIN", "COMPANY_TRAVEL_ARRANGER", "TRAVEL_ARRANGER", "COMPANY_REPORT_ADMIN", "GLOBAL_ADMIN", "GLOBAL_AGENT", "TMC_AGENT", "TMC_ADMIN"

  - `paymentSources.mapping.paymentSourceAttributes.includedPersonas` (array)
    If specified, list of traveler personas which have access to the payment source.
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `paymentSources.mapping.paymentSourceAttributes.excludedPersonas` (array)
    List of traveler personas which don't have access to the payment source.
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `paymentSources.mapping.paymentSourceAttributes.allowedThirdPartySources` (array)
    List of 3rd party sources supported for the payment source.
    Enum: "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"

  - `paymentSources.mapping.paymentSourceAttributes.allowedTripTypes` (array)
    List of trip types supported for the payment source.
    Enum: "STANDARD", "EVENT"

  - `paymentSources.mapping.paymentSourceAttributes.priority` (integer)
    Priority of payment source used to order while listing payment sources. Priority is a positive number.
    Example: 2

  - `paymentSources.mapping.paymentSourceAttributes.guestTravelAllowed` (boolean)
    Whether guest travel is allowed.

  - `paymentSources.mapping.accessTypeAttributes` (object)
    Attributes applicable to the access type.

  - `paymentSources.mapping.accessTypeAttributes.travelTypeFilter` (object)
    Filter for selecting payment sources according to different types of travel.

  - `paymentSources.mapping.accessTypeAttributes.travelTypeFilter.travelTypes` (array)
    Applicable travel types for Payment Source.

  - `paymentSources.mapping.travelType` (array)
    Applicable payment source travel type.

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 404 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.