---
title: "Get transferable unused credits for a company"
method: POST
path: "/v3/air/company-transferable-unused-credits/list"
tags: ["Air Credits"]
---

# Get transferable unused credits for a company

`POST /v3/air/company-transferable-unused-credits/list`

Returns the list of transferable company unused credits which can be used by any employees of the company.
The unused credits can be transferred to another traveler.

## Request body

- CompanyTransferableUnusedCreditsListRequest — Request for fetching unused credits for a company.
  - `companyId` object, required
    - `id` string, uuid, required
  - `companyCreditFilter` CompanyCreditFilter — Filter for fetching company credits.
    - `supplier` 'SABRE' | 'AMADEUS' | 'TRAVEL_FUSION' | 'FARELOGIX_NDC' | 'ATPCO_NDC' | 'TRAINLINE' | 'AVIA' | 'QBR' | 'BCD' | 'QANTAS_HOTELS' | 'SOUTHWEST' | 'EXPEDIA' | 'HOTEL_HUB' | 'NDC' | 'MARRIOTT' | 'CLEARTRIP' | 'KYTE' | 'GROUNDSPAN' | 'SABRE_NDC' | 'BOOKING_COM' | 'CARTRAWLER' | 'PREMIER_INN' | 'TRAVELODGE' | 'ENTERPRISE' | 'HYATT' | 'NATIONAL' | 'ALAMO' | 'HERTZ' | 'DOLLAR' | 'THRIFTY' | 'FIREFLY' | 'EUROSTAR' | 'AVIS' | 'BUDGET' — Supplier type like Sabre, TravelFusion etc.
    - `selectedAirlines` string[]
    - `expiryDateRange` object
      - `expiryDateStart` DateModel — Date in ISO 8601 standard.
        - `iso8601` string, required
      - `expiryDateEnd` DateModel — Date in ISO 8601 standard.
        - `iso8601` string, required
    - `fopLabel` string[] — FOP labels for which the credits should be fetched.
    - `pcc` string — Deprecated: Use pccs instead. PCC for which the credits should be fetched. Ignored when pccs is set.
    - `pccs` string[] — List of PCCs for which the credits should be fetched. Takes precedence over 'pcc' when both are set.
    - `fopCardAccessType` UnusedCreditFopCardAccessType[] — FOP card access types for which the credits should be fetched.
    - `legalEntityNames` string[] — Legal entity names for which the credits should be fetched.
  - `offset` integer

## Response `200`

OK

- CompanyTransferableUnusedCreditsListResponse — Response body for company transferable unused credits
  - `unusedCreditInfos` UnusedCreditInfo[]
    - `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
      - `airlineCode` string, required — IATA code for airline.
      - `airlineName` string, required — Airline name
    - `totalFare` Money — Money object containing details such as the amount, the currency code, and the converted amount.
      - `amount` number, double, required — The numeric value for the amount of money.
      - `currencyCode` string, required — The 3-letter currency code for the money amount (defined using ISO 4217 standard).
      - `convertedAmount` number, double — The converted currency and amount that has been converted (if a currency conversion has been requested). For example, if the call requests that money be sent in a specified currency (because the frontend requested the backend to send money in the user's preferred currency).
      - `convertedCurrency` string — The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
      - `otherCoinage` object[] — List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
        - `coinageCode` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
        - `amount` number, double
        - `conversionRate` number, double — 1 coin in this system equals to how many currency value
        - `preferredCurrencyConversionRate` number, double — 1 coin in this system equals to how many currency value
        - `otherCoinageMetadata` FlightPassPaymentMetadataWrapper — Wrapper for Flight Pass payment metadata.
          - `metadataType` string — Discriminator field for polymorphic deserialization
          - `flightPassMetadata` FlightPassPaymentMetadata, required — Metadata specific to Flight Pass payment method in OtherCoinage.
            - `flightPassNumber` string — Flight pass number
            - `flightPassAmounts` FlightPassPaymentAmounts — Fare breakdown for the flight pass booking.
              - …
    - `issueDate` DateTimeOffset — ISO8601 UTC Date Time
      - `iso8601` string, required
    - `expiryDate` DateTimeOffset — ISO8601 UTC Date Time
      - `iso8601` string, required
    - `usedDate` DateTimeOffset — ISO8601 UTC Date Time
      - `iso8601` string, required
    - `departureDate` DateTimeOffset — ISO8601 UTC Date Time
      - `iso8601` string, required
    - `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.
      - `family1` string, required — Last (family) name.
      - `family2` string
      - `given` string, required — First (given) name.
      - `middle` string — Middle name.
      - `suffix` 'NAME_SUFFIX_UNKNOWN' | 'SR' | 'JR' | 'MD' | 'PHD' | 'II' | 'III' | 'IV' | 'DO' | 'ATTY' | 'V' | 'VI' | 'ESQ' | 'DC' | 'DDS' | 'VM' | 'JD' | 'SECOND' | 'THIRD' — Suffix for name
      - `preferred` string — Informal preferred name added by traveler. This is not used on any PNR or tickets
    - `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.
      - `paymentMethod` 'PAYMENT_METHOD_UNKNOWN' | 'CREDIT_CARD' | 'BREX_POINTS' | 'CASH' | 'QANTAS_POINTS' | 'VENDOR_PROGRAM_PAYMENT' | 'DELAYED_INVOICING' | 'FLIGHT_CREDITS' | 'QANTAS_TRAVEL_FUND' | 'CUSTOM_VIRTUAL_PAYMENT' | 'FLIGHT_PASS' | 'MISCELLANEOUS_CREDIT_ORDER' | 'NO_PREPAYMENT' — Payment method
      - `paymentSourceType` 'CARD' | 'VIRTUAL_CARD' | 'REWARDS_PROGRAM' | 'DELAYED_INVOICING' | 'CUSTOM_PAYMENT_METHOD' | 'VENDOR_PROGRAM_PAYMENT' | 'UNUSED_CREDIT' | 'CASH' — Type of Payment Source
      - `card` Card — 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
          - `addressLines` string[], required — Address lines
          - `administrativeArea` string — Code of administrative area. For example: DL for Delhi, India. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
          - `administrativeAreaName` string — Name of administrative area. This is full name corresponding to administrativeArea. Like Delhi for DL area code. For some places, code and name maybe same as well like Tokyo.
          - `description` string — Address description
          - `isDefault` boolean — Whether this address is default address in case multiple addresses are specified.
          - `languageCode` string — BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. Examples: "zh-Hant", "ja", "ja-Latn", "en".
          - `locality` string — Generally refers to the city/town portion of the address.
          - `locationCode` string — IATA 3-letter location code. See https://www.iata.org/en/services/codes.
          - `organization` string — The name of the organization at the address.
          - `postalCode` string — Postal code of the address. This is a required field when setting for a user/legal entity/company etc.
          - `continentCode` string — 2 letter continent code of the continent this address falls in.
          - `recipients` string[] — The recipient at the address.
          - `regionCode` string, required — Region code of the country/region of the address.
          - `regionName` string — Region name of the country/region of the address.
          - `revision` integer
          - `sortingCode` string — Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
          - `sublocality` string — Sublocality of the address. This can be neighborhoods, boroughs, districts.
          - `timezone` string — Time zone of the address.
          - `coordinates` Latlng — Latitude and Longitude for a Location
            - `latitude` number, double, required — Latitude of the Location
            - `longitude` number, double, required — Longitude of the Location
        - `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.
          - object
            - `tokenizedExpiry` TokenizedExpiry — Contains the tokenized expiry of a Card.
              - …
          - object
            - `expiry` Expiry — Contains the expiry of a Card.
              - …
        - `ownershipLabel` 'CORPORATE' | 'PERSONAL' | 'CENTRAL' — Ownership label of the card whether it is personal, corporate or central.
    - `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.
      - `previousTicket` string — Previous ticket number in case of exchanges.
    - `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.
  - `paginationParams` object
    - `offset` integer
    - `totalRecords` integer
  - `companyTransferableFopLabels` string[] — List of distinct FOP labels for company transferable credits
  - `companyTransferablePccs` string[] — List of distinct PCCs for company transferable credits
  - `companyTransferableLegalEntityNames` string[] — List of distinct legal entity names for company transferable credits
  - `supportedAirlines` SupportedAirline[] — List of airlines that support unused credit transfers
    - `airlineCode` string — IATA airline code
    - `airlineName` string — Full airline name

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — The specified resource was not found.

---

[API](https://skmtc.net/spotnana/apis/air-api.md) · [All operations](https://skmtc.net/spotnana/apis/air-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/air-api/revisions/4dd80446ce32/schema)