Currency-Conversion-2021-03-22.v1.yaml

openapi: 3.0.3
info:
  title: Currency Conversions
  description: 'Currency Conversions represent the conversion, or attempt to convert, a Transaction amount to the equivalent amount in the currency of the Payer. This is referred to as DCC for Dynamic Currency Conversion'
  contact:
    name: API Integrations
    url: 'https://developer.globalpay.com'
    email: api.integrations@globalpay.com
  version: 2021 03 22
servers:
  - url: 'https://apis.sandbox.globalpay.com/ucp'
    description: Sandbox Environment
  - url: 'https://apis.globalpay.com/ucp'
    description: Production Environment
tags:
  - name: Convert Transaction Amount
    description: Request the conversion of a Sale or Refund Transaction amount to the equivalent amount in the currency of the Payer.
  - name: BIN Ranges List Download
    description: Download a list of BIN ranges that support Dynamic Currency Conversion (DCC).
paths:
  /currency-conversions:
    post:
      operationId: requestDCC
      tags:
        - Convert Transaction Amount
      summary: Request the conversion of a Sale or Refund Transaction amount to the equivalent amount in the currency of the Payer.
      description: Request the conversion of a Sale or Refund Transaction amount to the equivalent amount in the currency of the Payer.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer access token value used to access the API.
          schema:
            description: Bearer access token value used to access the API.
            type: string
            default: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
            example: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
        - in: header
          name: X-GP-Idempotency
          description: Integrator generated value submitted in the request header that is checked to ensure the same value has not been seen in the last 24 hours. It is used to ensure idempotency is maintained with this action.
          schema:
            description: Integrator generated value submitted in the request header that is checked to ensure the same value has not been seen in the last 24 hours. It is used to ensure idempotency is maintained with this action.
            type: string
            minLength: 1
            maxLength: 50
        - in: header
          name: X-GP-Version
          required: true
          schema:
            description: Indicates the version of the GP-API for this message.
            type: string
            default: '2021-03-22'
            minLength: 1
            maxLength: 50
          description: The version of the API to execute the request.
        - in: header
          name: Content-type
          description: Format of the message.
          required: true
          schema:
            description: Indicates the format of the message.
            type: string
            default: application/json
      requestBody:
        content:
          application/json:
            schema:
              required:
                - account_name
                - amount
                - channel
                - country
                - currency
                - payment_method
                - reference
              type: object
              properties:
                account_name:
                  type: string
                  description: A meaningful label for the merchant account set by Global Payments.
                  example: DCC
                  minLength: 1
                  maxLength: 50
                transaction_type:
                  type: string
                  description: |
                    Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or a REFUND where funds move from Merchant to Payer. 
                      * SALE - indicates the movement, or the attempt to move, funds from payer to a merchant. 
                      * REFUND - indicates the movement, or the attempt to move, funds from merchant to the payer.
                  example: SALE
                  default: SALE
                  enum:
                    - SALE
                    - REFUND
                channel:
                  type: string
                  description: |
                    Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario. 
                      * CP - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk. 
                      * CNP - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone
                  example: CNP
                  enum:
                    - CP
                    - CNP
                country:
                  type: string
                  description: The country in ISO-3166-1(alpha-2 code) format.
                  example: US
                  minLength: 1
                  maxLength: 255
                amount:
                  type: string
                  description: The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomiation of the related currency.
                  example: '11099'
                currency:
                  type: string
                  description: The currency of the amount in ISO-4217(alpha-3)
                  example: USD
                  minLength: 3
                  maxLength: 3
                reference:
                  type: string
                  description: Merchant defined field to reference the transaction.
                  minLength: 8
                  maxLength: 50
                  example: becf9f3e-4d33-459c-8ed2-0c4affc9555e
                payment_method:
                  type: object
                  properties:
                    entry_mode:
                      type: string
                      description: |
                        Indicates how the payment method information was obtained by the Merchant for this transaction. 
                          * MOTO - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail. 
                          * ECOM - A CNP channel entry mode where the payment method was obtained via a browser. 
                          * IN_APP - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only. 
                          * CHIP - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip. 
                          * SWIPE - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information. 
                          * MANUAL - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device. 
                          * CONTACTLESS_CHIP -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a cardon or near a device to exchange card information. 
                          * CONTACTLESS_SWIPE -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information 
                          * PHONE - A CNP channel entry mode where the payment method was obtained over the phone. 
                          * MAIL - A CNP channel entry mode where the payment method was obtained via postal mail.
                      example: ECOM
                      enum:
                        - MOTO
                        - ECOM
                        - IN_APP
                        - CHIP
                        - SWIPE
                        - MANUAL
                        - PHONE
                        - MAIL
                        - CONTACTLESS_CHIP
                        - CONTACTLESS_SWIPE
                      minLength: 1
                      maxLength: 50
                    card:
                      type: object
                      properties:
                        number:
                          type: string
                          description: The the card account number used to authorize the transaction. Also known as PAN.
                          example: '4263970000005262'
                          minLength: 1
                          maxLength: 50
                        expiry_month:
                          type: string
                          description: The 2 digit expiry date month of the card.
                          example: '05'
                          minLength: 2
                          maxLength: 2
                        expiry_year:
                          type: string
                          description: The 2 digit expiry date year of the card.
                          example: '25'
                          minLength: 2
                          maxLength: 2
            examples:
              DCC Rate Available:
                value:
                  account_name: DCC
                  channel: CNP
                  amount: '10000'
                  currency: USD
                  country: US
                  reference: becf9f3e-4d33-459c-8ed2-0c4affc9555e
                  payment_method:
                    name: James Mason
                    entry_mode: ECOM
                    card:
                      number: '4006097467207025'
                      expiry_month: '05'
                      expiry_year: '25'
              DCC Rate Not Available:
                value:
                  account_name: DCC
                  channel: CNP
                  amount: '10000'
                  currency: USD
                  country: US
                  reference: becf9f3e-4d33-459c-8ed2-0c4affc9555e
                  payment_method:
                    name: James Mason
                    entry_mode: ECOM
                    card:
                      number: '4263970000005262'
                      expiry_month: '05'
                      expiry_year: '25'
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                description: Indicates the format of the message.
                type: string
                default: application/json
            Content-Encoding:
              schema:
                description: Indicates if the message is compressed and using what compression mechanism.
                type: string
                default: gzip
            X-GP-Idempotency:
              schema:
                description: Integrator generated value submitted in the request header that is checked to ensure the same value has not been seen in the last 24 hours. It is used to ensure idempotency is maintained with this action.
                type: string
                minLength: 1
                maxLength: 50
            X-GP-Version:
              schema:
                description: Indicates the version of the GP-API for this message.
                type: string
                default: '2021-03-22'
                minLength: 1
                maxLength: 50
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: A unique identifier generated by Global Payments to identify the transaction.
                    example: TRN_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                    minLength: 4
                    maxLength: 100
                  time_created:
                    type: string
                    format: date-time
                    description: Global Payments time indicating when the object was created in ISO-8601 format.
                    example: '2021-05-03T21:23:39.718Z'
                  model:
                    type: string
                    description: |
                      The currency exchange rate model used.
                        * FROM_TRANSACTION_CURRENCY - indicates the conversion was executed using from the currency and amount of the transaction.
                    enum:
                      - FROM_TRANSACTION_CURRENCY
                    minLength: 0
                    maxLength: 50
                  status:
                    type: string
                    description: |
                      Indicates where the currency conversion is in its lifecycle 
                        * AVAILABLE - A currency conversion is available. The next step is to offer the conversion details to the end user.
                        * NOT_AVAILABLE - A currency conversion is not available.
                    enum:
                      - AVAILABLE
                      - NOT_AVAILABLE
                    minLength: 0
                    maxLength: 50
                  country:
                    type: string
                    description: The country in ISO-3166-1(alpha-2 code) format.
                    example: US
                    minLength: 1
                    maxLength: 255
                  transaction_type:
                    type: string
                    description: |
                      Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or a REFUND where funds move from Merchant to Payer. 
                        * SALE - indicates the movement, or the attempt to move, funds from payer to a merchant. 
                        * REFUND - indicates the movement, or the attempt to move, funds from merchant to the payer.
                    example: SALE
                    default: SALE
                    enum:
                      - SALE
                      - REFUND
                  channel:
                    type: string
                    description: |
                      Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario. 
                        * CP - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk. 
                        * CNP - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone
                    example: CNP
                    enum:
                      - CP
                      - CNP
                  amount:
                    type: string
                    description: The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomiation of the related currency.
                    example: '11099'
                  currency:
                    type: string
                    description: The currency of the amount in ISO-4217(alpha-3)
                    example: USD
                    minLength: 3
                    maxLength: 3
                  minor_units:
                    x-stoplight:
                      id: 1mzyhnb2pp9a2
                    type: string
                    example: '2'
                    description: The number of decimal places of the payer currency. This field is intended for formatting and display purposes only.
                    enum:
                      - '0'
                      - '2'
                      - '3'
                  formatted_amount:
                    x-stoplight:
                      id: 6q27feep0j54p
                    type: string
                    description: The payer amount formatted according to the number of minor units (decimal places) of that currency. This field is intended for formatting and display purposes only.
                    example: '105.55'
                  exchange_rate:
                    type: string
                    description: The exchange rate used to convert one currency to another.
                    minLength: 0
                    maxLength: 50
                    example: '1.8117'
                  payer_amount:
                    type: string
                    description: The amount that will affect the payer's account.
                    minLength: 0
                    maxLength: 50
                    example: '223665'
                  payer_currency:
                    type: string
                    description: The currency of the amount that will affect the payer's account.
                    minLength: 0
                    maxLength: 50
                    example: AUD
                  margin_rate_percentage:
                    type: string
                    description: The exchange rate used to convert one currency to another.
                    minLength: 0
                    maxLength: 50
                    example: '03.7500'
                  exchange_rate_source:
                    type: string
                    description: The source of the base exchange rate was obtained to execute the currency conversion.
                    minLength: 0
                    maxLength: 50
                    example: REUTERS WHOLESALE INTERBANK
                  exchange_rate_time_created:
                    type: string
                    description: The time the base exchange rate was obtained from the source.
                    minLength: 0
                    maxLength: 50
                    example: '2018-08-20T11:18'
                  commission_percentage:
                    type: string
                    description: The percentage commission taken for providing the currency conversion.
                    minLength: 0
                    maxLength: 50
                    example: '00.0000'
                  merchant_id:
                    type: string
                    description: A unique identifier for the merchant set by Global Payments.
                    example: MER_c4c0df11039c48a9b63701adeaa296c3
                    minLength: 1
                    maxLength: 50
                  merchant_name:
                    type: string
                    description: A meaningful label for the merchant set by Global Payments.
                    example: Sandbox_merchant_2
                    minLength: 1
                    maxLength: 50
                  account_id:
                    type: string
                    description: A unique identifier for the merchant account set by Global Payments.
                    minLength: 1
                    maxLength: 50
                    example: TRA_86920f927028745yt34d077d88beb29b
                  account_name:
                    type: string
                    description: A meaningful label for the merchant account set by Global Payments.
                    minLength: 1
                    maxLength: 50
                    example: transaction_processing
                  reference:
                    type: string
                    description: Merchant defined field to reference the transaction.
                    minLength: 8
                    maxLength: 50
                    example: becf9f3e-4d33-459c-8ed2-0c4affc9555e
                  payment_method:
                    type: object
                    properties:
                      result:
                        type: string
                        example: '00'
                        description: Result code from the payment method provider.
                      message:
                        type: string
                        example: Successful
                        description: Result message from the payment method provider corresponding to the result code.
                      entry_mode:
                        type: string
                        description: |
                          Indicates how the payment method information was obtained by the Merchant for this transaction. 
                            * MOTO - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail. 
                            * ECOM - A CNP channel entry mode where the payment method was obtained via a browser. 
                            * IN_APP - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only. 
                            * CHIP - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip. 
                            * SWIPE - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information. 
                            * MANUAL - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device. 
                            * CONTACTLESS_CHIP -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a cardon or near a device to exchange card information. 
                            * CONTACTLESS_SWIPE -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information 
                            * PHONE - A CNP channel entry mode where the payment method was obtained over the phone. 
                            * MAIL - A CNP channel entry mode where the payment method was obtained via postal mail.
                        example: ECOM
                        enum:
                          - MOTO
                          - ECOM
                          - IN_APP
                          - CHIP
                          - SWIPE
                          - MANUAL
                          - PHONE
                          - MAIL
                          - CONTACTLESS_CHIP
                          - CONTACTLESS_SWIPE
                        minLength: 1
                        maxLength: 50
                      card:
                        type: object
                        properties:
                          masked_number_last4:
                            type: string
                            description: Masked card number with last 4 digits.
                            minLength: 12
                            maxLength: 50
                            example: XXXXXXXXXXXX7025
                          brand:
                            type: string
                            description: Indicates the card brand that issued the card.
                            enum:
                              - VISA
                              - MASTERCARD
                              - AMEX
                              - DINERS
                              - DISCOVER
                              - JCB
                              - CUP
                            minLength: 0
                            maxLength: 50
                  action:
                    type: object
                    description: Information about the Action executed.
                    properties:
                      id:
                        type: string
                        description: A unique identifier generated by Global Payments to identify an action.
                        example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                        minLength: 1
                        maxLength: 50
                      type:
                        type: string
                        description: Indicates the action taken.
                      time_created:
                        type: string
                        format: date-time
                        description: Global Payments time indicating when the object was created in ISO-8601 format.
                        example: '2021-05-03T21:23:39.718Z'
                      result_code:
                        type: string
                        description: The result of the action executed.
                        enum:
                          - SUCCESS
                          - DECLINE
                        minLength: 1
                        maxLength: 50
                      app_id:
                        type: string
                        description: The id of the app that was used to create the token.
                        example: U1lRHKomEn7DN907RCDPxVhyMfiMLcfy
                        minLength: 1
                        maxLength: 50
                      app_name:
                        type: string
                        description: The name of the app the user gave to the application.
                        example: demo_app
                        minLength: 1
                        maxLength: 50
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                description: Bad Request
                type: object
                properties:
                  error_code:
                    type: string
                    description: This indicates an issue with the API request.
                    example: MANDATORY_DATA_MISSING
                    enum:
                      - DUPLICATE_TRANSACTION
                      - INVALID_BATCH_ACTION
                      - INVALID_REQUEST_DATA
                      - INVALID_TRANSACTION_ACTION
                      - MANDATORY_DATA_MISSING
                      - TRANSACTION_NOT_FOUND
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '40016'
                    enum:
                      - '40016'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Bad track data
        '401':
          description: Not Authenticated
          content:
            application/json:
              schema:
                description: Not Authenticated
                type: object
                properties:
                  error_code:
                    type: string
                    description: This action failed as token in the request is not valid.
                    example: NOT_AUTHENTICATED
                    enum:
                      - NOT_AUTHENTICATED
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '40001'
                    enum:
                      - '40001'
                      - '40002'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Invalid Access Token
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                description: Forbidden
                type: object
                properties:
                  error_code:
                    type: string
                    description: This action is not authorized with the credentials being used.
                    example: ACTION_NOT_AUTHORIZED
                    enum:
                      - ACTION_NOT_AUTHORIZED
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '40003'
                    enum:
                      - '40003'
                      - '40004'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Permission not enabled to execute action
        '404':
          description: Resource Not Found
          content: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: Internal Server Error
                type: object
                properties:
                  error_code:
                    type: string
                    description: This indicates an unexpected issue occurred on the Global Payments system.
                    example: SYSTEM_ERROR_DOWNSTREAM
                    enum:
                      - SYSTEM_ERROR_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '50011'
                    enum:
                      - '50011'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Processor Configuration error
        '501':
          description: Not implemented
          content:
            application/json:
              schema:
                description: Not implemented
                type: object
                properties:
                  error_code:
                    type: string
                    description: This is an error not yet handled or mapped properly.
                    example: UNKNOWN_RESPONSE
                    enum:
                      - UNKNOWN_RESPONSE
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '50012'
                    enum:
                      - '50012'
                  detailed_error_description:
                    type: string
                    description: 'Unique Text describing the specific error not yet handled.      '
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                description: Bad Gateway
                type: object
                properties:
                  error_code:
                    type: string
                    description: This is an error indicating there was an issue connecting to a partner system..
                    example: UNAUTHORIZED_DOWNSTREAM
                    enum:
                      - UNAUTHORIZED_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '50002'
                    enum:
                      - '50002'
                  detailed_error_description:
                    type: string
                    description: Authentication error—Verify and correct credentials.
        '504':
          description: Timeout
          content:
            application/json:
              schema:
                description: Timeout
                type: object
                properties:
                  error_code:
                    type: string
                    description: This is an error indicating there was a timeout issue to another  system.
                    example: TIMEOUT_DOWNSTREAM
                    enum:
                      - TIMEOUT_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '50008'
                    enum:
                      - '50008'
                  detailed_error_description:
                    type: string
                    description: No response from payment method provider.
    parameters: []
  /currency-conversions/dcc-bin-ranges:
    get:
      summary: Download a list of Dynamic Currency Conversion (DCC) BIN ranges.
      operationId: Download-DCC-BIN-Ranges-List
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  time_created:
                    type: string
                    format: date-time
                    description: Global Payments time indicating when the object was created in ISO-8601 format.
                    example: '2021-05-03T21:23:39.718Z'
                  is_last_page:
                    type: string
                    description: Indicates whether there are more pages of BIN ranges available.
                    example: 'NO'
                    enum:
                      - 'YES'
                      - 'NO'
                  time_retrieved:
                    x-stoplight:
                      id: e38v0cr2whtgq
                    type: string
                    description: 'Date the BIN ranges were obtained. For subsequent requests if this date is provided, only updates after this date will be returned. '
                  current_index:
                    type: number
                    description: The current index of the BIN table that has been returned. Can be used to obtain the next set of values by passing it as a search parameter in last_index.
                    example: 20
                  current_page_size:
                    type: number
                    description: The total number of records returned on the current page. If current_page_size is less than the page_size using in the querystring then this is the final page for that search.
                    maximum: 1000
                    minimum: 1
                    default: 1
                  merchant_id:
                    type: string
                    description: A unique identifier for the merchant set by Global Payments.
                    example: MER_c4c0df11039c48a9b63701adeaa296c3
                    minLength: 1
                    maxLength: 50
                  merchant_name:
                    type: string
                    description: A meaningful label for the merchant set by Global Payments.
                    example: Sandbox_merchant_2
                    minLength: 1
                    maxLength: 50
                  account_id:
                    type: string
                    description: A unique identifier for the merchant account set by Global Payments.
                    minLength: 1
                    maxLength: 50
                    example: TRA_86920f927028745yt34d077d88beb29b
                  account_name:
                    type: string
                    description: A meaningful label for the merchant account set by Global Payments.
                    minLength: 1
                    maxLength: 50
                    example: transaction_processing
                  paging:
                    type: object
                    description: Standard paging is not supported for this request type.
                  filter:
                    type: object
                    properties:
                      country:
                        type: string
                        description: The country in ISO-3166-1(alpha-2 code) format.
                        example: US
                        minLength: 1
                        maxLength: 255
                      merchant_currency:
                        type: string
                        description: The base currency of the merchant in ISO-4217(alpha-3).
                        example: USD
                      payer_currency:
                        type: array
                        description: The currency or list of currencies that the merchant accepts in ISO-4217(alpha-3).
                        example:
                          - GBP
                          - EUR
                        x-examples: {}
                        items:
                          type: string
                          example: '["GBP","EUR"]'
                        title: ''
                  dcc_bin_ranges:
                    type: array
                    uniqueItems: true
                    minItems: 1
                    items:
                      type: object
                      properties:
                        low_prefix_number:
                          type: string
                          description: Lower limit of the BIN range.
                          example: '2222420010'
                        high_prefix_number:
                          type: string
                          description: Higher limit of the BIN range.
                          example: '2222420269'
                        status:
                          type: string
                          enum:
                            - ACTIVE
                            - INACTIVE
                          example: ACTIVE
                          description: The status of the BIN ranges. Can be ACTIVE or INACTIVE.
                  action:
                    type: object
                    properties:
                      id:
                        type: string
                        description: A unique identifier generated by Global Payments to identify an action.
                        example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                        minLength: 1
                        maxLength: 50
                      type:
                        type: string
                        description: The type of action executed.
                        example: PREAUTHORIZE
                        enum:
                          - AUTHORIZE
                          - PREAUTHORIZE
                          - DCC_BIN_RANGE_LIST
                      time_created:
                        type: string
                        format: date-time
                        description: Global Payments time indicating when the object was created in ISO-8601 format.
                        example: '2021-05-03T21:23:39.718Z'
                      result_code:
                        type: string
                        description: The result of the action executed.
                        enum:
                          - SUCCESS
                          - DECLINE
                        minLength: 1
                        maxLength: 50
                      app_id:
                        type: string
                        description: The id of the app that was used to create the token.
                        example: U1lRHKomEn7DN907RCDPxVhyMfiMLcfy
                        minLength: 1
                        maxLength: 50
                      app_name:
                        type: string
                        description: The name of the app the user gave to the application.
                        example: demo_app
                        minLength: 1
                        maxLength: 50
              examples:
                Merchant Currency Only:
                  value:
                    time_created: '2022-04-11T13:29:10.596Z'
                    is_last_page: 'NO'
                    time_retrieved: '2022-04-11'
                    current_index: 40
                    current_page_size: 20
                    merchant_id: MER_c4c0df11039c48a9b63701adeaa296c3
                    merchant_name: Sandbox_merchant_2
                    account_id: TRA_d9eea42b1f30482cae161c732d837ed6
                    account_name: Transaction_Processing
                    filter:
                      country: GB
                      merchant_currency: GBP
                    paging: {}
                    dcc_bin_ranges:
                      - low_prefix_number: '2222420010'
                        high_prefix_number: '2222420269'
                        status: ACTIVE
                      - low_prefix_number: '2222650010'
                        high_prefix_number: '2222650129'
                        status: ACTIVE
                      - low_prefix_number: '2222670010'
                        high_prefix_number: '2222670129'
                        status: ACTIVE
                      - low_prefix_number: '2222680130'
                        high_prefix_number: '2222740129'
                        status: ACTIVE
                      - low_prefix_number: '2222750130'
                        high_prefix_number: '2222760159'
                        status: ACTIVE
                      - low_prefix_number: '2222780010'
                        high_prefix_number: '2222780159'
                        status: ACTIVE
                      - low_prefix_number: '2222820010'
                        high_prefix_number: '2222840129'
                        status: ACTIVE
                      - low_prefix_number: '2222860010'
                        high_prefix_number: '2222870129'
                        status: ACTIVE
                      - low_prefix_number: '2223290010'
                        high_prefix_number: '2223290159'
                        status: ACTIVE
                      - low_prefix_number: '2223330010'
                        high_prefix_number: '2223340129'
                        status: ACTIVE
                      - low_prefix_number: '2223360010'
                        high_prefix_number: '2223360129'
                        status: ACTIVE
                      - low_prefix_number: '2223400010'
                        high_prefix_number: '2223400129'
                        status: ACTIVE
                      - low_prefix_number: '2223420010'
                        high_prefix_number: '2223420129'
                        status: ACTIVE
                      - low_prefix_number: '2223440010'
                        high_prefix_number: '2223460129'
                        status: ACTIVE
                      - low_prefix_number: '2223590300'
                        high_prefix_number: '2223590300'
                        status: ACTIVE
                      - low_prefix_number: '2223600089'
                        high_prefix_number: '2223600089'
                        status: ACTIVE
                      - low_prefix_number: '2226789800'
                        high_prefix_number: '2226789999'
                        status: ACTIVE
                      - low_prefix_number: '2233160010'
                        high_prefix_number: '2233160019'
                        status: ACTIVE
                      - low_prefix_number: '2308270002'
                        high_prefix_number: '2308270009'
                        status: ACTIVE
                      - low_prefix_number: '2720020100'
                        high_prefix_number: '2720022099'
                        status: ACTIVE
                    action:
                      id: ACT_Kq7jZogQ5mRsY4yvwXguw3iizKGUdI
                      type: DCC_BIN_RANGE_LIST
                      time_created: '2022-04-11T17:48:14.215Z'
                      result_code: SUCCESS
                      app_id: Cu7y0m3XmoACrLohnRyDHVgRS4sC7hS5
                      app_name: DCCPP
                Payer Currency:
                  value:
                    time_created: '2022-04-11T13:29:10.596Z'
                    is_last_page: 'NO'
                    time_retrieved: '2022-04-11'
                    current_index: 40
                    current_page_size: 20
                    merchant_id: MER_c4c0df11039c48a9b63701adeaa296c3
                    merchant_name: Sandbox_merchant_2
                    account_id: TRA_d9eea42b1f30482cae161c732d837ed6
                    account_name: Transaction_Processing
                    filter:
                      country: US
                      merchant_currency: USD
                      payer_currency:
                        - EUR
                        - GBP
                    paging: {}
                    dcc_bin_ranges:
                      - low_prefix_number: '2222420010'
                        high_prefix_number: '2222420269'
                        status: ACTIVE
                      - low_prefix_number: '2222650010'
                        high_prefix_number: '2222650129'
                        status: ACTIVE
                      - low_prefix_number: '2222670010'
                        high_prefix_number: '2222670129'
                        status: ACTIVE
                      - low_prefix_number: '2222680130'
                        high_prefix_number: '2222740129'
                        status: ACTIVE
                      - low_prefix_number: '2222750130'
                        high_prefix_number: '2222760159'
                        status: ACTIVE
                      - low_prefix_number: '2222780010'
                        high_prefix_number: '2222780159'
                        status: ACTIVE
                      - low_prefix_number: '2222820010'
                        high_prefix_number: '2222840129'
                        status: ACTIVE
                      - low_prefix_number: '2222860010'
                        high_prefix_number: '2222870129'
                        status: ACTIVE
                      - low_prefix_number: '2223290010'
                        high_prefix_number: '2223290159'
                        status: ACTIVE
                      - low_prefix_number: '2223330010'
                        high_prefix_number: '2223340129'
                        status: ACTIVE
                      - low_prefix_number: '2223360010'
                        high_prefix_number: '2223360129'
                        status: ACTIVE
                      - low_prefix_number: '2223400010'
                        high_prefix_number: '2223400129'
                        status: ACTIVE
                      - low_prefix_number: '2223420010'
                        high_prefix_number: '2223420129'
                        status: ACTIVE
                      - low_prefix_number: '2223440010'
                        high_prefix_number: '2223460129'
                        status: ACTIVE
                      - low_prefix_number: '2223590300'
                        high_prefix_number: '2223590300'
                        status: ACTIVE
                      - low_prefix_number: '2223600089'
                        high_prefix_number: '2223600089'
                        status: ACTIVE
                      - low_prefix_number: '2226789800'
                        high_prefix_number: '2226789999'
                        status: ACTIVE
                      - low_prefix_number: '2233160010'
                        high_prefix_number: '2233160019'
                        status: ACTIVE
                      - low_prefix_number: '2308270002'
                        high_prefix_number: '2308270009'
                        status: ACTIVE
                      - low_prefix_number: '2720020100'
                        high_prefix_number: '2720022099'
                        status: ACTIVE
                    action:
                      id: ACT_Kq7jZogQ5mRsY4yvwXguw3iizKGUdI
                      type: DCC_BIN_RANGE_LIST
                      time_created: '2022-04-11T17:48:14.215Z'
                      result_code: SUCCESS
                      app_id: Cu7y0m3XmoACrLohnRyDHVgRS4sC7hS5
                      app_name: DCCPP
        '400':
          description: ''
          content:
            application/json:
              schema:
                description: Bad Request
                type: object
                properties:
                  error_code:
                    type: string
                    description: This indicates an issue with the API request.
                    example: MANDATORY_DATA_MISSING
                    enum:
                      - DUPLICATE_TRANSACTION
                      - INVALID_BATCH_ACTION
                      - INVALID_REQUEST_DATA
                      - INVALID_TRANSACTION_ACTION
                      - MANDATORY_DATA_MISSING
                      - TRANSACTION_NOT_FOUND
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '40016'
                    enum:
                      - '40016'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Bad track data
        '401':
          description: ''
          content:
            application/json:
              schema:
                description: Not Authenticated
                type: object
                properties:
                  error_code:
                    type: string
                    description: This action failed as token in the request is not valid.
                    example: NOT_AUTHENTICATED
                    enum:
                      - NOT_AUTHENTICATED
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '40001'
                    enum:
                      - '40001'
                      - '40002'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Invalid Access Token
        '403':
          description: ''
          content:
            application/json:
              schema:
                description: Forbidden
                type: object
                properties:
                  error_code:
                    type: string
                    description: This action is not authorized with the credentials being used.
                    example: ACTION_NOT_AUTHORIZED
                    enum:
                      - ACTION_NOT_AUTHORIZED
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '40003'
                    enum:
                      - '40003'
                      - '40004'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Permission not enabled to execute action
        '404':
          description: ''
          content:
            application/json:
              schema:
                title: NotFound
                type: object
                properties:
                  error_code:
                    type: string
                    example: RESOURCE_NOT_FOUND
                    enum:
                      - RESOURCE_NOT_FOUND
                  detailed_error_code:
                    type: string
                    enum:
                      - '40118'
                    example: '40118'
                  detailed_error_description:
                    type: string
                    example: Resource ID not found.
        '500':
          description: ''
          content:
            application/json:
              schema:
                description: Internal Server Error
                type: object
                properties:
                  error_code:
                    type: string
                    description: This indicates an unexpected issue occurred on the Global Payments system.
                    example: SYSTEM_ERROR_DOWNSTREAM
                    enum:
                      - SYSTEM_ERROR_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '50011'
                    enum:
                      - '50011'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Processor Configuration error
        '501':
          description: ''
          content:
            application/json:
              schema:
                description: Not implemented
                type: object
                properties:
                  error_code:
                    type: string
                    description: This is an error not yet handled or mapped properly.
                    example: UNKNOWN_RESPONSE
                    enum:
                      - UNKNOWN_RESPONSE
                  detailed_error_code:
                    type: string
                    description: Unique reference to identify the error.
                    example: '50012'
                    enum:
                      - '50012'
                  detailed_error_description:
                    type: string
                    description: 'Unique Text describing the specific error not yet handled.      '
      description: Download a list of BIN ranges that support Dynamic Currency Conversion (DCC). The list can be filtered solely based on the merchant's base currency or the list of payer currencies the merchant supports. The list can be stored locally on the device so a presented card number can be checked to determine if DCC is supported before performing an actual DCC Rate Lookup request.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer access token value used to access the API.
          schema:
            description: Bearer access token value used to access the API.
            type: string
            default: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
            example: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
        - in: header
          name: X-GP-Version
          required: true
          schema:
            description: Indicates the version of the GP-API for this message.
            type: string
            default: '2021-03-22'
            minLength: 1
            maxLength: 50
          description: The version of the API to execute the request.
        - in: header
          name: Accept
          description: Expected format of the response message.
          schema:
            description: Expected format of the response message.
            type: string
            default: application/json
            example: application/json
        - name: account_name
          in: query
          required: false
          schema:
            type: string
            example: Transaction_Processing
            minLength: 1
            maxLength: 50
          description: A meaningful label for the merchant account set by Global Payments.
        - name: account_id
          in: query
          required: false
          schema:
            type: string
            example: TRA_6716058969854a48b33347043ff8225f
            minLength: 1
            maxLength: 50
          description: A unique identifier for the merchant account set by Global Payments.
        - name: country
          in: query
          required: true
          schema:
            type: string
            example: US
          description: The country in ISO-3166-1(alpha-2 code) format.
        - name: merchant_currency
          in: query
          required: true
          schema:
            type: string
            example: USD
          description: The base currency of the merchant in ISO-4217(alpha-3).
        - name: payer_currency
          in: query
          required: false
          schema:
            type: array
          description: The currency or list of currencies that the merchant accepts in ISO-4217(alpha-3).
        - in: query
          name: time_last_received
          description: The date to start obtaining updated information from.
        - name: last_index
          in: query
          required: false
          schema:
            type: number
          description: The index number to start obtaining information from.
      tags:
        - BIN Ranges List Download
    parameters: []
components:
  schemas:
    create_request:
      required:
        - account_name
        - amount
        - channel
        - country
        - currency
        - payment_method
        - reference
      type: object
      properties:
        account_name:
          type: string
          description: A meaningful label for the merchant account set by Global Payments.
          example: DCC
          minLength: 1
          maxLength: 50
        transaction_type:
          type: string
          description: |
            Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or a REFUND where funds move from Merchant to Payer. 
              * SALE - indicates the movement, or the attempt to move, funds from payer to a merchant. 
              * REFUND - indicates the movement, or the attempt to move, funds from merchant to the payer.
          example: SALE
          default: SALE
          enum:
            - SALE
            - REFUND
        channel:
          type: string
          description: |
            Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario. 
              * CP - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk. 
              * CNP - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone
          example: CNP
          enum:
            - CP
            - CNP
        country:
          type: string
          description: The country in ISO-3166-1(alpha-2 code) format.
          example: US
          minLength: 1
          maxLength: 255
        amount:
          type: string
          description: The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomiation of the related currency.
          example: '11099'
        currency:
          type: string
          description: The currency of the amount in ISO-4217(alpha-3)
          example: USD
          minLength: 3
          maxLength: 3
        reference:
          type: string
          description: Merchant defined field to reference the transaction.
          minLength: 8
          maxLength: 50
          example: becf9f3e-4d33-459c-8ed2-0c4affc9555e
        payment_method:
          type: object
          properties:
            entry_mode:
              type: string
              description: |
                Indicates how the payment method information was obtained by the Merchant for this transaction. 
                  * MOTO - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail. 
                  * ECOM - A CNP channel entry mode where the payment method was obtained via a browser. 
                  * IN_APP - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only. 
                  * CHIP - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip. 
                  * SWIPE - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information. 
                  * MANUAL - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device. 
                  * CONTACTLESS_CHIP -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a cardon or near a device to exchange card information. 
                  * CONTACTLESS_SWIPE -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information 
                  * PHONE - A CNP channel entry mode where the payment method was obtained over the phone. 
                  * MAIL - A CNP channel entry mode where the payment method was obtained via postal mail.
              example: ECOM
              enum:
                - MOTO
                - ECOM
                - IN_APP
                - CHIP
                - SWIPE
                - MANUAL
                - PHONE
                - MAIL
                - CONTACTLESS_CHIP
                - CONTACTLESS_SWIPE
              minLength: 1
              maxLength: 50
            card:
              type: object
              properties:
                number:
                  type: string
                  description: The the card account number used to authorize the transaction. Also known as PAN.
                  example: '4263970000005262'
                  minLength: 1
                  maxLength: 50
                expiry_month:
                  type: string
                  description: The 2 digit expiry date month of the card.
                  example: '05'
                  minLength: 2
                  maxLength: 2
                expiry_year:
                  type: string
                  description: The 2 digit expiry date year of the card.
                  example: '25'
                  minLength: 2
                  maxLength: 2
    create_response:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier generated by Global Payments to identify the transaction.
          example: TRN_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
          minLength: 4
          maxLength: 100
        time_created:
          type: string
          format: date-time
          description: Global Payments time indicating when the object was created in ISO-8601 format.
          example: '2021-05-03T21:23:39.718Z'
        model:
          type: string
          description: |
            The currency exchange rate model used.
              * FROM_TRANSACTION_CURRENCY - indicates the conversion was executed using from the currency and amount of the transaction.
          enum:
            - FROM_TRANSACTION_CURRENCY
          minLength: 0
          maxLength: 50
        status:
          type: string
          description: |
            Indicates where the currency conversion is in its lifecycle 
              * AVAILABLE - A currency conversion is available. The next step is to offer the conversion details to the end user.
              * NOT_AVAILABLE - A currency conversion is not available.
          enum:
            - AVAILABLE
            - NOT_AVAILABLE
          minLength: 0
          maxLength: 50
        country:
          type: string
          description: The country in ISO-3166-1(alpha-2 code) format.
          example: US
          minLength: 1
          maxLength: 255
        transaction_type:
          type: string
          description: |
            Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or a REFUND where funds move from Merchant to Payer. 
              * SALE - indicates the movement, or the attempt to move, funds from payer to a merchant. 
              * REFUND - indicates the movement, or the attempt to move, funds from merchant to the payer.
          example: SALE
          default: SALE
          enum:
            - SALE
            - REFUND
        channel:
          type: string
          description: |
            Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario. 
              * CP - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk. 
              * CNP - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone
          example: CNP
          enum:
            - CP
            - CNP
        amount:
          type: string
          description: The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomiation of the related currency.
          example: '11099'
        currency:
          type: string
          description: The currency of the amount in ISO-4217(alpha-3)
          example: USD
          minLength: 3
          maxLength: 3
        minor_units:
          x-stoplight:
            id: 1mzyhnb2pp9a2
          type: string
          example: '2'
          description: The number of decimal places of the payer currency. This field is intended for formatting and display purposes only.
          enum:
            - '0'
            - '2'
            - '3'
        formatted_amount:
          x-stoplight:
            id: 6q27feep0j54p
          type: string
          description: The payer amount formatted according to the number of minor units (decimal places) of that currency. This field is intended for formatting and display purposes only.
          example: '105.55'
        exchange_rate:
          type: string
          description: The exchange rate used to convert one currency to another.
          minLength: 0
          maxLength: 50
          example: '1.8117'
        payer_amount:
          type: string
          description: The amount that will affect the payer's account.
          minLength: 0
          maxLength: 50
          example: '223665'
        payer_currency:
          type: string
          description: The currency of the amount that will affect the payer's account.
          minLength: 0
          maxLength: 50
          example: AUD
        margin_rate_percentage:
          type: string
          description: The exchange rate used to convert one currency to another.
          minLength: 0
          maxLength: 50
          example: '03.7500'
        exchange_rate_source:
          type: string
          description: The source of the base exchange rate was obtained to execute the currency conversion.
          minLength: 0
          maxLength: 50
          example: REUTERS WHOLESALE INTERBANK
        exchange_rate_time_created:
          type: string
          description: The time the base exchange rate was obtained from the source.
          minLength: 0
          maxLength: 50
          example: '2018-08-20T11:18'
        commission_percentage:
          type: string
          description: The percentage commission taken for providing the currency conversion.
          minLength: 0
          maxLength: 50
          example: '00.0000'
        merchant_id:
          type: string
          description: A unique identifier for the merchant set by Global Payments.
          example: MER_c4c0df11039c48a9b63701adeaa296c3
          minLength: 1
          maxLength: 50
        merchant_name:
          type: string
          description: A meaningful label for the merchant set by Global Payments.
          example: Sandbox_merchant_2
          minLength: 1
          maxLength: 50
        account_id:
          type: string
          description: A unique identifier for the merchant account set by Global Payments.
          minLength: 1
          maxLength: 50
          example: TRA_86920f927028745yt34d077d88beb29b
        account_name:
          type: string
          description: A meaningful label for the merchant account set by Global Payments.
          minLength: 1
          maxLength: 50
          example: transaction_processing
        reference:
          type: string
          description: Merchant defined field to reference the transaction.
          minLength: 8
          maxLength: 50
          example: becf9f3e-4d33-459c-8ed2-0c4affc9555e
        payment_method:
          type: object
          properties:
            result:
              type: string
              example: '00'
              description: Result code from the payment method provider.
            message:
              type: string
              example: Successful
              description: Result message from the payment method provider corresponding to the result code.
            entry_mode:
              type: string
              description: |
                Indicates how the payment method information was obtained by the Merchant for this transaction. 
                  * MOTO - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail. 
                  * ECOM - A CNP channel entry mode where the payment method was obtained via a browser. 
                  * IN_APP - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only. 
                  * CHIP - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip. 
                  * SWIPE - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information. 
                  * MANUAL - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device. 
                  * CONTACTLESS_CHIP -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a cardon or near a device to exchange card information. 
                  * CONTACTLESS_SWIPE -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information 
                  * PHONE - A CNP channel entry mode where the payment method was obtained over the phone. 
                  * MAIL - A CNP channel entry mode where the payment method was obtained via postal mail.
              example: ECOM
              enum:
                - MOTO
                - ECOM
                - IN_APP
                - CHIP
                - SWIPE
                - MANUAL
                - PHONE
                - MAIL
                - CONTACTLESS_CHIP
                - CONTACTLESS_SWIPE
              minLength: 1
              maxLength: 50
            card:
              type: object
              properties:
                masked_number_last4:
                  type: string
                  description: Masked card number with last 4 digits.
                  minLength: 12
                  maxLength: 50
                  example: XXXXXXXXXXXX7025
                brand:
                  type: string
                  description: Indicates the card brand that issued the card.
                  enum:
                    - VISA
                    - MASTERCARD
                    - AMEX
                    - DINERS
                    - DISCOVER
                    - JCB
                    - CUP
                  minLength: 0
                  maxLength: 50
        action:
          type: object
          description: Information about the Action executed.
          properties:
            id:
              type: string
              description: A unique identifier generated by Global Payments to identify an action.
              example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
              minLength: 1
              maxLength: 50
            type:
              type: string
              description: Indicates the action taken.
            time_created:
              type: string
              format: date-time
              description: Global Payments time indicating when the object was created in ISO-8601 format.
              example: '2021-05-03T21:23:39.718Z'
            result_code:
              type: string
              description: The result of the action executed.
              enum:
                - SUCCESS
                - DECLINE
              minLength: 1
              maxLength: 50
            app_id:
              type: string
              description: The id of the app that was used to create the token.
              example: U1lRHKomEn7DN907RCDPxVhyMfiMLcfy
              minLength: 1
              maxLength: 50
            app_name:
              type: string
              description: The name of the app the user gave to the application.
              example: demo_app
              minLength: 1
              maxLength: 50
    payment_method_request:
      type: object
      properties:
        entry_mode:
          type: string
          description: |
            Indicates how the payment method information was obtained by the Merchant for this transaction. 
              * MOTO - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail. 
              * ECOM - A CNP channel entry mode where the payment method was obtained via a browser. 
              * IN_APP - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only. 
              * CHIP - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip. 
              * SWIPE - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information. 
              * MANUAL - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device. 
              * CONTACTLESS_CHIP -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a cardon or near a device to exchange card information. 
              * CONTACTLESS_SWIPE -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information 
              * PHONE - A CNP channel entry mode where the payment method was obtained over the phone. 
              * MAIL - A CNP channel entry mode where the payment method was obtained via postal mail.
          example: ECOM
          enum:
            - MOTO
            - ECOM
            - IN_APP
            - CHIP
            - SWIPE
            - MANUAL
            - PHONE
            - MAIL
            - CONTACTLESS_CHIP
            - CONTACTLESS_SWIPE
          minLength: 1
          maxLength: 50
        card:
          type: object
          properties:
            number:
              type: string
              description: The the card account number used to authorize the transaction. Also known as PAN.
              example: '4263970000005262'
              minLength: 1
              maxLength: 50
            expiry_month:
              type: string
              description: The 2 digit expiry date month of the card.
              example: '05'
              minLength: 2
              maxLength: 2
            expiry_year:
              type: string
              description: The 2 digit expiry date year of the card.
              example: '25'
              minLength: 2
              maxLength: 2
    payment_method_response:
      type: object
      properties:
        result:
          type: string
          example: '00'
          description: Result code from the payment method provider.
        message:
          type: string
          example: Successful
          description: Result message from the payment method provider corresponding to the result code.
        entry_mode:
          type: string
          description: |
            Indicates how the payment method information was obtained by the Merchant for this transaction. 
              * MOTO - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail. 
              * ECOM - A CNP channel entry mode where the payment method was obtained via a browser. 
              * IN_APP - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only. 
              * CHIP - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip. 
              * SWIPE - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information. 
              * MANUAL - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device. 
              * CONTACTLESS_CHIP -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a cardon or near a device to exchange card information. 
              * CONTACTLESS_SWIPE -  A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information 
              * PHONE - A CNP channel entry mode where the payment method was obtained over the phone. 
              * MAIL - A CNP channel entry mode where the payment method was obtained via postal mail.
          example: ECOM
          enum:
            - MOTO
            - ECOM
            - IN_APP
            - CHIP
            - SWIPE
            - MANUAL
            - PHONE
            - MAIL
            - CONTACTLESS_CHIP
            - CONTACTLESS_SWIPE
          minLength: 1
          maxLength: 50
        card:
          type: object
          properties:
            masked_number_last4:
              type: string
              description: Masked card number with last 4 digits.
              minLength: 12
              maxLength: 50
              example: XXXXXXXXXXXX7025
            brand:
              type: string
              description: Indicates the card brand that issued the card.
              enum:
                - VISA
                - MASTERCARD
                - AMEX
                - DINERS
                - DISCOVER
                - JCB
                - CUP
              minLength: 0
              maxLength: 50
    card_request:
      type: object
      properties:
        number:
          type: string
          description: The the card account number used to authorize the transaction. Also known as PAN.
          example: '4263970000005262'
          minLength: 1
          maxLength: 50
        expiry_month:
          type: string
          description: The 2 digit expiry date month of the card.
          example: '05'
          minLength: 2
          maxLength: 2
        expiry_year:
          type: string
          description: The 2 digit expiry date year of the card.
          example: '25'
          minLength: 2
          maxLength: 2
    card_response:
      type: object
      properties:
        masked_number_last4:
          type: string
          description: Masked card number with last 4 digits.
          minLength: 12
          maxLength: 50
          example: XXXXXXXXXXXX7025
        brand:
          type: string
          description: Indicates the card brand that issued the card.
          enum:
            - VISA
            - MASTERCARD
            - AMEX
            - DINERS
            - DISCOVER
            - JCB
            - CUP
          minLength: 0
          maxLength: 50
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
  examples: {}
  responses:
    '400':
      description: ''
      content:
        application/json:
          schema:
            description: Bad Request
            type: object
            properties:
              error_code:
                type: string
                description: This indicates an issue with the API request.
                example: MANDATORY_DATA_MISSING
                enum:
                  - DUPLICATE_TRANSACTION
                  - INVALID_BATCH_ACTION
                  - INVALID_REQUEST_DATA
                  - INVALID_TRANSACTION_ACTION
                  - MANDATORY_DATA_MISSING
                  - TRANSACTION_NOT_FOUND
              detailed_error_code:
                type: string
                description: Unique reference to identify the error.
                example: '40016'
                enum:
                  - '40016'
              detailed_error_description:
                type: string
                description: Unique Text describing the specific error.
                example: Bad track data
    '401':
      description: ''
      content:
        application/json:
          schema:
            description: Not Authenticated
            type: object
            properties:
              error_code:
                type: string
                description: This action failed as token in the request is not valid.
                example: NOT_AUTHENTICATED
                enum:
                  - NOT_AUTHENTICATED
              detailed_error_code:
                type: string
                description: Unique reference to identify the error.
                example: '40001'
                enum:
                  - '40001'
                  - '40002'
              detailed_error_description:
                type: string
                description: Unique Text describing the specific error.
                example: Invalid Access Token
    '403':
      description: ''
      content:
        application/json:
          schema:
            description: Forbidden
            type: object
            properties:
              error_code:
                type: string
                description: This action is not authorized with the credentials being used.
                example: ACTION_NOT_AUTHORIZED
                enum:
                  - ACTION_NOT_AUTHORIZED
              detailed_error_code:
                type: string
                description: Unique reference to identify the error.
                example: '40003'
                enum:
                  - '40003'
                  - '40004'
              detailed_error_description:
                type: string
                description: Unique Text describing the specific error.
                example: Permission not enabled to execute action
    '404':
      description: ''
      content:
        application/json:
          schema:
            title: NotFound
            type: object
            properties:
              error_code:
                type: string
                example: RESOURCE_NOT_FOUND
                enum:
                  - RESOURCE_NOT_FOUND
              detailed_error_code:
                type: string
                enum:
                  - '40118'
                example: '40118'
              detailed_error_description:
                type: string
                example: Resource ID not found.
    '500':
      description: ''
      content:
        application/json:
          schema:
            description: Internal Server Error
            type: object
            properties:
              error_code:
                type: string
                description: This indicates an unexpected issue occurred on the Global Payments system.
                example: SYSTEM_ERROR_DOWNSTREAM
                enum:
                  - SYSTEM_ERROR_DOWNSTREAM
              detailed_error_code:
                type: string
                description: Unique reference to identify the error.
                example: '50011'
                enum:
                  - '50011'
              detailed_error_description:
                type: string
                description: Unique Text describing the specific error.
                example: Processor Configuration error
    '501':
      description: ''
      content:
        application/json:
          schema:
            description: Not implemented
            type: object
            properties:
              error_code:
                type: string
                description: This is an error not yet handled or mapped properly.
                example: UNKNOWN_RESPONSE
                enum:
                  - UNKNOWN_RESPONSE
              detailed_error_code:
                type: string
                description: Unique reference to identify the error.
                example: '50012'
                enum:
                  - '50012'
              detailed_error_description:
                type: string
                description: 'Unique Text describing the specific error not yet handled.      '
    DCC-BIN-Ranges-Download-Response:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              time_created:
                type: string
                format: date-time
                description: Global Payments time indicating when the object was created in ISO-8601 format.
                example: '2021-05-03T21:23:39.718Z'
              is_last_page:
                type: string
                description: Indicates whether there are more pages of BIN ranges available.
                example: 'NO'
                enum:
                  - 'YES'
                  - 'NO'
              time_retrieved:
                x-stoplight:
                  id: e38v0cr2whtgq
                type: string
                description: 'Date the BIN ranges were obtained. For subsequent requests if this date is provided, only updates after this date will be returned. '
              current_index:
                type: number
                description: The current index of the BIN table that has been returned. Can be used to obtain the next set of values by passing it as a search parameter in last_index.
                example: 20
              current_page_size:
                type: number
                description: The total number of records returned on the current page. If current_page_size is less than the page_size using in the querystring then this is the final page for that search.
                maximum: 1000
                minimum: 1
                default: 1
              merchant_id:
                type: string
                description: A unique identifier for the merchant set by Global Payments.
                example: MER_c4c0df11039c48a9b63701adeaa296c3
                minLength: 1
                maxLength: 50
              merchant_name:
                type: string
                description: A meaningful label for the merchant set by Global Payments.
                example: Sandbox_merchant_2
                minLength: 1
                maxLength: 50
              account_id:
                type: string
                description: A unique identifier for the merchant account set by Global Payments.
                minLength: 1
                maxLength: 50
                example: TRA_86920f927028745yt34d077d88beb29b
              account_name:
                type: string
                description: A meaningful label for the merchant account set by Global Payments.
                minLength: 1
                maxLength: 50
                example: transaction_processing
              paging:
                type: object
                description: Standard paging is not supported for this request type.
              filter:
                type: object
                properties:
                  country:
                    type: string
                    description: The country in ISO-3166-1(alpha-2 code) format.
                    example: US
                    minLength: 1
                    maxLength: 255
                  merchant_currency:
                    type: string
                    description: The base currency of the merchant in ISO-4217(alpha-3).
                    example: USD
                  payer_currency:
                    type: array
                    description: The currency or list of currencies that the merchant accepts in ISO-4217(alpha-3).
                    example:
                      - GBP
                      - EUR
                    x-examples: {}
                    items:
                      type: string
                      example: '["GBP","EUR"]'
                    title: ''
              dcc_bin_ranges:
                type: array
                uniqueItems: true
                minItems: 1
                items:
                  type: object
                  properties:
                    low_prefix_number:
                      type: string
                      description: Lower limit of the BIN range.
                      example: '2222420010'
                    high_prefix_number:
                      type: string
                      description: Higher limit of the BIN range.
                      example: '2222420269'
                    status:
                      type: string
                      enum:
                        - ACTIVE
                        - INACTIVE
                      example: ACTIVE
                      description: The status of the BIN ranges. Can be ACTIVE or INACTIVE.
              action:
                type: object
                properties:
                  id:
                    type: string
                    description: A unique identifier generated by Global Payments to identify an action.
                    example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                    minLength: 1
                    maxLength: 50
                  type:
                    type: string
                    description: The type of action executed.
                    example: PREAUTHORIZE
                    enum:
                      - AUTHORIZE
                      - PREAUTHORIZE
                      - DCC_BIN_RANGE_LIST
                  time_created:
                    type: string
                    format: date-time
                    description: Global Payments time indicating when the object was created in ISO-8601 format.
                    example: '2021-05-03T21:23:39.718Z'
                  result_code:
                    type: string
                    description: The result of the action executed.
                    enum:
                      - SUCCESS
                      - DECLINE
                    minLength: 1
                    maxLength: 50
                  app_id:
                    type: string
                    description: The id of the app that was used to create the token.
                    example: U1lRHKomEn7DN907RCDPxVhyMfiMLcfy
                    minLength: 1
                    maxLength: 50
                  app_name:
                    type: string
                    description: The name of the app the user gave to the application.
                    example: demo_app
                    minLength: 1
                    maxLength: 50
          examples:
            Merchant Currency Only:
              value:
                time_created: '2022-04-11T13:29:10.596Z'
                is_last_page: 'NO'
                time_retrieved: '2022-04-11'
                current_index: 40
                current_page_size: 20
                merchant_id: MER_c4c0df11039c48a9b63701adeaa296c3
                merchant_name: Sandbox_merchant_2
                account_id: TRA_d9eea42b1f30482cae161c732d837ed6
                account_name: Transaction_Processing
                filter:
                  country: GB
                  merchant_currency: GBP
                paging: {}
                dcc_bin_ranges:
                  - low_prefix_number: '2222420010'
                    high_prefix_number: '2222420269'
                    status: ACTIVE
                  - low_prefix_number: '2222650010'
                    high_prefix_number: '2222650129'
                    status: ACTIVE
                  - low_prefix_number: '2222670010'
                    high_prefix_number: '2222670129'
                    status: ACTIVE
                  - low_prefix_number: '2222680130'
                    high_prefix_number: '2222740129'
                    status: ACTIVE
                  - low_prefix_number: '2222750130'
                    high_prefix_number: '2222760159'
                    status: ACTIVE
                  - low_prefix_number: '2222780010'
                    high_prefix_number: '2222780159'
                    status: ACTIVE
                  - low_prefix_number: '2222820010'
                    high_prefix_number: '2222840129'
                    status: ACTIVE
                  - low_prefix_number: '2222860010'
                    high_prefix_number: '2222870129'
                    status: ACTIVE
                  - low_prefix_number: '2223290010'
                    high_prefix_number: '2223290159'
                    status: ACTIVE
                  - low_prefix_number: '2223330010'
                    high_prefix_number: '2223340129'
                    status: ACTIVE
                  - low_prefix_number: '2223360010'
                    high_prefix_number: '2223360129'
                    status: ACTIVE
                  - low_prefix_number: '2223400010'
                    high_prefix_number: '2223400129'
                    status: ACTIVE
                  - low_prefix_number: '2223420010'
                    high_prefix_number: '2223420129'
                    status: ACTIVE
                  - low_prefix_number: '2223440010'
                    high_prefix_number: '2223460129'
                    status: ACTIVE
                  - low_prefix_number: '2223590300'
                    high_prefix_number: '2223590300'
                    status: ACTIVE
                  - low_prefix_number: '2223600089'
                    high_prefix_number: '2223600089'
                    status: ACTIVE
                  - low_prefix_number: '2226789800'
                    high_prefix_number: '2226789999'
                    status: ACTIVE
                  - low_prefix_number: '2233160010'
                    high_prefix_number: '2233160019'
                    status: ACTIVE
                  - low_prefix_number: '2308270002'
                    high_prefix_number: '2308270009'
                    status: ACTIVE
                  - low_prefix_number: '2720020100'
                    high_prefix_number: '2720022099'
                    status: ACTIVE
                action:
                  id: ACT_Kq7jZogQ5mRsY4yvwXguw3iizKGUdI
                  type: DCC_BIN_RANGE_LIST
                  time_created: '2022-04-11T17:48:14.215Z'
                  result_code: SUCCESS
                  app_id: Cu7y0m3XmoACrLohnRyDHVgRS4sC7hS5
                  app_name: DCCPP
            Payer Currency:
              value:
                time_created: '2022-04-11T13:29:10.596Z'
                is_last_page: 'NO'
                time_retrieved: '2022-04-11'
                current_index: 40
                current_page_size: 20
                merchant_id: MER_c4c0df11039c48a9b63701adeaa296c3
                merchant_name: Sandbox_merchant_2
                account_id: TRA_d9eea42b1f30482cae161c732d837ed6
                account_name: Transaction_Processing
                filter:
                  country: US
                  merchant_currency: USD
                  payer_currency:
                    - EUR
                    - GBP
                paging: {}
                dcc_bin_ranges:
                  - low_prefix_number: '2222420010'
                    high_prefix_number: '2222420269'
                    status: ACTIVE
                  - low_prefix_number: '2222650010'
                    high_prefix_number: '2222650129'
                    status: ACTIVE
                  - low_prefix_number: '2222670010'
                    high_prefix_number: '2222670129'
                    status: ACTIVE
                  - low_prefix_number: '2222680130'
                    high_prefix_number: '2222740129'
                    status: ACTIVE
                  - low_prefix_number: '2222750130'
                    high_prefix_number: '2222760159'
                    status: ACTIVE
                  - low_prefix_number: '2222780010'
                    high_prefix_number: '2222780159'
                    status: ACTIVE
                  - low_prefix_number: '2222820010'
                    high_prefix_number: '2222840129'
                    status: ACTIVE
                  - low_prefix_number: '2222860010'
                    high_prefix_number: '2222870129'
                    status: ACTIVE
                  - low_prefix_number: '2223290010'
                    high_prefix_number: '2223290159'
                    status: ACTIVE
                  - low_prefix_number: '2223330010'
                    high_prefix_number: '2223340129'
                    status: ACTIVE
                  - low_prefix_number: '2223360010'
                    high_prefix_number: '2223360129'
                    status: ACTIVE
                  - low_prefix_number: '2223400010'
                    high_prefix_number: '2223400129'
                    status: ACTIVE
                  - low_prefix_number: '2223420010'
                    high_prefix_number: '2223420129'
                    status: ACTIVE
                  - low_prefix_number: '2223440010'
                    high_prefix_number: '2223460129'
                    status: ACTIVE
                  - low_prefix_number: '2223590300'
                    high_prefix_number: '2223590300'
                    status: ACTIVE
                  - low_prefix_number: '2223600089'
                    high_prefix_number: '2223600089'
                    status: ACTIVE
                  - low_prefix_number: '2226789800'
                    high_prefix_number: '2226789999'
                    status: ACTIVE
                  - low_prefix_number: '2233160010'
                    high_prefix_number: '2233160019'
                    status: ACTIVE
                  - low_prefix_number: '2308270002'
                    high_prefix_number: '2308270009'
                    status: ACTIVE
                  - low_prefix_number: '2720020100'
                    high_prefix_number: '2720022099'
                    status: ACTIVE
                action:
                  id: ACT_Kq7jZogQ5mRsY4yvwXguw3iizKGUdI
                  type: DCC_BIN_RANGE_LIST
                  time_created: '2022-04-11T17:48:14.215Z'
                  result_code: SUCCESS
                  app_id: Cu7y0m3XmoACrLohnRyDHVgRS4sC7hS5
                  app_name: DCCPP
security:
  - bearerAuth: []