2021-03-22v1/Batches-2021-03-22.v1.yaml

openapi: 3.0.2
info:
  version: 2021 03 22
  title: Batches
  description: |
    A Batch represents a group of transactions that commence the funding process together.  Batches have aggregate amount and count totals of all the transactions in the batch.
    Once a batch is closed all transactions assigned to that batch will be funded to the merchant.
    Once a batch is closed no more transactions can be added or removed from that batch. 
    Transactions that are in a closed batch cannot be cancelled/reversed and must be refunded.
  contact:
    name: API Integrations
    url: 'https://developer.globalpay.com/?gp-api=true'
    email: api.integrations@globalpay.com
servers:
  - url: 'https://apis.sandbox.globalpay.com/ucp'
    description: Sandbox Environment
  - url: 'https://apis.globalpay.com/ucp'
    description: Production Environment
paths:
  '/batches/{id}':
    get:
      tags:
        - Get a Batch
      summary: Get a single view of a Batch using the Global Payments Batch id.
      description: Get a single view of a Batch using the Global Payments Batch id.
      operationId: getSingleBatch
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
            minLength: 1
            maxLength: 50
            example: BAT_855049-899
        - name: Authorization
          in: header
          description: Bearer access token value used to authorize and access the API.  Must always begin with the string "Bearer".
          required: true
          schema:
            type: string
            default: Bearer CdqyD9r7orAGau004u5NecG03JPy
            example: Bearer CdqyD9r7orAGau004u5NecG03JPy
        - name: X-GP-Version
          in: header
          description: The version of the API to execute the request.
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 50
            default: '2021-03-22'
            example: '2021-03-22'
        - name: Accept
          in: header
          description: Indicates the expected format of the message response.
          required: false
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: GetResponse
                properties:
                  id:
                    type: string
                    description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
                    minLength: 1
                    maxLength: 50
                    example: BAT_855049-899
                  status:
                    type: string
                    description: |
                      Indicates where a batch is in its life cycle. *`OPEN` - Batch is open and can accept more transactions.
                      *`CLOSED` - Batch is closed and cannot accept more transactions.
                    example: OPEN
                  time_created:
                    type: string
                    description: Global Payments time indicating when the object was created in ISO-8601 format..
                    minLength: 1
                    maxLength: 50
                    example: '2021-05-03T21:23:39.718Z'
                  time_closed:
                    type: string
                    description: Global Payments generated time indicating when the batch was closed
                    minLength: 1
                    maxLength: 50
                    example: '2021-05-03T21:23:39.718Z'
                  open_action_id:
                    type: string
                    description: An identifier generated by Global Payments to uniquely identify the action that opened the batch.
                    minLength: 1
                    maxLength: 50
                    example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                  close_action_id:
                    type: string
                    description: An identifier generated by Global Payments to uniquely identify the action that closed the batch.
                    minLength: 1
                    maxLength: 50
                    example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                  merchant_id:
                    type: string
                    description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific merchant. Begins with the three letters, MER.'
                    minLength: 1
                    maxLength: 50
                    example: MER_A6A1EC44522F96630ABEA17A
                  merchant_name:
                    type: string
                    description: A meaningful label that better identifies the merchant.
                    minLength: 1
                    maxLength: 50
                    example: ABC INDUSTRIES
                  account_id:
                    type: string
                    description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific account. Begins with the three letters, TRA.'
                    minLength: 1
                    maxLength: 50
                    example: TRA_86920f927028745yt34d077d88beb29b
                  account_name:
                    type: string
                    description: A meaningful label that better identifies the account.
                    minLength: 1
                    maxLength: 50
                    example: transaction_processing
                  site_reference:
                    type: string
                    description: A reference for the location that created the batch.
                    minLength: 1
                    maxLength: 50
                  device_reference:
                    type: string
                    description: A reference for the device that created the batch
                    minLength: 1
                    maxLength: 50
                  batch_transaction_count:
                    type: number
                    description: The number of transactions in the batch.
                    example: 126
                  amount:
                    type: string
                    description: The batch amount that is an aggregation of all the transactions' amounts in the batch. It is always represented in the lowest denomination of the related currency.
                    example: '12000'
                  currency:
                    type: string
                    description: The currency of the amount in ISO-4217(alpha-3)
                    minLength: 3
                    maxLength: 3
                    example: USD
                  gratuity_amount:
                    type: string
                    description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch. It is always represented in the lowest denomination of the related currency.
                    example: '500'
                  sales:
                    type: object
                    properties:
                      count:
                        type: number
                        description: The total number of Sale transactions.
                        example: 123
                      amount:
                        type: string
                        description: The total amount of Sale transactions.
                        example: '12300'
                  refunds:
                    type: object
                    properties:
                      count:
                        type: number
                        description: The total number of Refund transactions.
                        example: 3
                      amount:
                        type: string
                        description: The total amount of Refund transactions.
                        example: '300'
                  funding_debit:
                    type: object
                    properties:
                      count:
                        type: number
                        description: The total number of Debit card transactions.
                        example: 100
                      amount:
                        type: string
                        description: The total amount of Debit card transactions.
                        example: '10000'
                  funding_credit:
                    type: object
                    properties:
                      count:
                        type: number
                        description: The total number of Credit card transactions.
                        example: 26
                      amount:
                        type: string
                        description: The total amount of Credit card transactions.
                        example: '2300'
                  brand_breakdown:
                    type: array
                    items:
                      type: object
                      properties:
                        brand:
                          type: string
                          enum:
                            - VISA
                            - MASTERCARD
                            - AMEX
                            - DINERS
                            - DISCOVER
                            - JCB
                            - CUP
                          description: Indicates the card brand that this batch summary pertains to.
                          minLength: 1
                          maxLength: 50
                          example: VISA
                        amount:
                          type: string
                          description: The batch amount that is an aggregation of all the transactions' amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
                          example: '8300'
                        count:
                          type: number
                          description: The number of transactions in the batch for this brand.
                          example: 83
                        gratuity_amount:
                          type: string
                          description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
                          example: '500'
                        sales:
                          type: object
                          properties:
                            count:
                              type: number
                              description: The total number of Sale transactions for this brand.
                              example: 80
                            amount:
                              type: string
                              description: The total amount of Sale transactions for this brand.
                              example: '8000'
                        refunds:
                          type: object
                          properties:
                            count:
                              type: number
                              description: The total number of Refund transactions for this brand.
                              example: 3
                            amount:
                              type: string
                              description: The total amount of Refund transactions for this brand.
                              example: '300'
                        funding_debit:
                          type: object
                          properties:
                            count:
                              type: number
                              description: The total number of Debit card transactions for this brand.
                              example: 80
                            amount:
                              type: string
                              description: The total amount of Debit card transactions for this brand.
                              example: '8000'
                        funding_credit:
                          type: object
                          properties:
                            count:
                              type: number
                              description: The total number of Credit card transactions for this brand.
                              example: 3
                            amount:
                              type: string
                              description: The total amount of Credit card transactions for this brand.
                              example: '300'
                  action:
                    type: object
                    properties:
                      id:
                        type: string
                        description: A unique identifier generated by Global Payments to identify an action.
                        example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                      type:
                        type: string
                        enum:
                          - BATCH_SINGLE
                          - CLOSE
                        description: Indicates the specific action taken.
                        example: BATCH_SINGLE
                      time_created:
                        type: string
                        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
                        enum:
                          - SUCCESS
                        description: The result of the action executed.
                        minLength: 1
                        maxLength: 50
                        example: SUCCESS
                      app_id:
                        type: string
                        description: The id of the app that was used to create the token.
                        minLength: 1
                        maxLength: 50
                        example: uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                      app_name:
                        type: string
                        description: The name of the app the user gave to the application.
                        minLength: 1
                        maxLength: 50
                        example: my_lovely_app
                x-examples: {}
          headers:
            Content-Type:
              schema:
                name: Content-type
                in: header
                required: true
                schema:
                  type: string
                  default: application/json
                  example: application/json
                description: Format of the message body.
            Content-Encoding:
              schema:
                name: Content-type
                in: header
                required: true
                schema:
                  type: string
                  default: application/json
                  example: application/json
                description: Format of the message body.
            X-GP-Version:
              schema:
                name: Content-type
                in: header
                required: true
                schema:
                  type: string
                  default: application/json
                  example: application/json
                description: Format of the message body.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: Bad Request
                properties:
                  error_code:
                    type: string
                    enum:
                      - DUPLICATE_TRANSACTION
                      - INVALID_BATCH_ACTION
                      - INVALID_REQUEST_DATA
                      - INVALID_TRANSACTION_ACTION
                      - MANDATORY_DATA_MISSING
                      - TRANSACTION_NOT_FOUND
                    description: This indicates an issue with the API request.
                    example: MANDATORY_DATA_MISSING
                  detailed_error_code:
                    type: string
                    enum:
                      - '40016'
                    description: Unique reference to identify the error.
                    example: '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:
                type: object
                description: Not Authenticated
                properties:
                  error_code:
                    type: string
                    enum:
                      - NOT_AUTHENTICATED
                    description: This action failed as token in the request is not valid.
                    example: NOT_AUTHENTICATED
                  detailed_error_code:
                    type: string
                    enum:
                      - '40001'
                      - '40002'
                    description: Unique reference to identify the error.
                    example: '40001'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Invalid Access Token
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: Forbidden
                properties:
                  error_code:
                    type: string
                    enum:
                      - ACTION_NOT_AUTHORIZED
                    description: This action is not authorized with the credentials being used.
                    example: ACTION_NOT_AUTHORIZED
                  detailed_error_code:
                    type: string
                    enum:
                      - '40003'
                      - '40004'
                    description: Unique reference to identify the error.
                    example: '40003'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Permission not enabled to execute action
        '404':
          description: Resource Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: Internal Server Error
                properties:
                  error_code:
                    type: string
                    enum:
                      - SYSTEM_ERROR_DOWNSTREAM
                    description: This indicates an unexpected issue occurred on the Global Payments system.
                    example: SYSTEM_ERROR_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    enum:
                      - '50011'
                    description: Unique reference to identify the error.
                    example: '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:
                type: object
                description: Not implemented
                properties:
                  error_code:
                    type: string
                    enum:
                      - UNKNOWN_RESPONSE
                    description: This is an error not yet handled or mapped properly.
                    example: UNKNOWN_RESPONSE
                  detailed_error_code:
                    type: string
                    enum:
                      - '50012'
                    description: Unique reference to identify the error.
                    example: '50012'
                  detailed_error_description:
                    type: string
                    description: 'Unique Text describing the specific error not yet handled.      '
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                description: Bad Gateway
                properties:
                  error_code:
                    type: string
                    enum:
                      - UNAUTHORIZED_DOWNSTREAM
                    description: This is an error indicating there was an issue connecting to a partner system..
                    example: UNAUTHORIZED_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    enum:
                      - '50002'
                    description: Unique reference to identify the error.
                    example: '50002'
                  detailed_error_description:
                    type: string
                    description: Authentication error—Verify and correct credentials.
        '504':
          description: Timeout
          content:
            application/json:
              schema:
                type: object
                description: Timeout
                properties:
                  error_code:
                    type: string
                    enum:
                      - TIMEOUT_DOWNSTREAM
                    description: This is an error indicating there was a timeout issue to another  system.
                    example: TIMEOUT_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    enum:
                      - '50008'
                    description: Unique reference to identify the error.
                    example: '50008'
                  detailed_error_description:
                    type: string
                    description: No response from payment method provider.
      servers:
        - url: 'https://apis.sandbox.globalpay.com/ucp'
          description: Sandbox Environment
        - url: 'https://apis.globalpay.com/ucp'
          description: Production Environment
    post:
      tags:
        - Close a Batch
      summary: Close a Batch using the Global Payments Batch id.
      description: Closing a batch results in commencement of funding to the merchant all the transactions in that batch.
      operationId: closeSingleBatch
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
            minLength: 1
            maxLength: 50
            example: BAT_855049-899
        - name: Authorization
          in: header
          description: Bearer access token value used to authorize and access the API.  Must always begin with the string "Bearer".
          required: true
          schema:
            type: string
            default: Bearer CdqyD9r7orAGau004u5NecG03JPy
            example: Bearer CdqyD9r7orAGau004u5NecG03JPy
        - name: X-GP-Version
          in: header
          description: The version of the API to execute the request.
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 50
            default: '2021-03-22'
            example: '2021-03-22'
        - name: Accept
          in: header
          description: Indicates the expected format of the message response.
          required: false
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: GetResponse
                properties:
                  id:
                    type: string
                    description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
                    minLength: 1
                    maxLength: 50
                    example: BAT_855049-899
                  status:
                    type: string
                    description: |
                      Indicates where a batch is in its life cycle. *`OPEN` - Batch is open and can accept more transactions.
                      *`CLOSED` - Batch is closed and cannot accept more transactions.
                    example: OPEN
                  time_created:
                    type: string
                    description: Global Payments time indicating when the object was created in ISO-8601 format..
                    minLength: 1
                    maxLength: 50
                    example: '2021-05-03T21:23:39.718Z'
                  time_closed:
                    type: string
                    description: Global Payments generated time indicating when the batch was closed
                    minLength: 1
                    maxLength: 50
                    example: '2021-05-03T21:23:39.718Z'
                  open_action_id:
                    type: string
                    description: An identifier generated by Global Payments to uniquely identify the action that opened the batch.
                    minLength: 1
                    maxLength: 50
                    example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                  close_action_id:
                    type: string
                    description: An identifier generated by Global Payments to uniquely identify the action that closed the batch.
                    minLength: 1
                    maxLength: 50
                    example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                  merchant_id:
                    type: string
                    description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific merchant. Begins with the three letters, MER.'
                    minLength: 1
                    maxLength: 50
                    example: MER_A6A1EC44522F96630ABEA17A
                  merchant_name:
                    type: string
                    description: A meaningful label that better identifies the merchant.
                    minLength: 1
                    maxLength: 50
                    example: ABC INDUSTRIES
                  account_id:
                    type: string
                    description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific account. Begins with the three letters, TRA.'
                    minLength: 1
                    maxLength: 50
                    example: TRA_86920f927028745yt34d077d88beb29b
                  account_name:
                    type: string
                    description: A meaningful label that better identifies the account.
                    minLength: 1
                    maxLength: 50
                    example: transaction_processing
                  site_reference:
                    type: string
                    description: A reference for the location that created the batch.
                    minLength: 1
                    maxLength: 50
                  device_reference:
                    type: string
                    description: A reference for the device that created the batch
                    minLength: 1
                    maxLength: 50
                  batch_transaction_count:
                    type: number
                    description: The number of transactions in the batch.
                    example: 126
                  amount:
                    type: string
                    description: The batch amount that is an aggregation of all the transactions' amounts in the batch. It is always represented in the lowest denomination of the related currency.
                    example: '12000'
                  currency:
                    type: string
                    description: The currency of the amount in ISO-4217(alpha-3)
                    minLength: 3
                    maxLength: 3
                    example: USD
                  gratuity_amount:
                    type: string
                    description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch. It is always represented in the lowest denomination of the related currency.
                    example: '500'
                  sales:
                    type: object
                    properties:
                      count:
                        type: number
                        description: The total number of Sale transactions.
                        example: 123
                      amount:
                        type: string
                        description: The total amount of Sale transactions.
                        example: '12300'
                  refunds:
                    type: object
                    properties:
                      count:
                        type: number
                        description: The total number of Refund transactions.
                        example: 3
                      amount:
                        type: string
                        description: The total amount of Refund transactions.
                        example: '300'
                  funding_debit:
                    type: object
                    properties:
                      count:
                        type: number
                        description: The total number of Debit card transactions.
                        example: 100
                      amount:
                        type: string
                        description: The total amount of Debit card transactions.
                        example: '10000'
                  funding_credit:
                    type: object
                    properties:
                      count:
                        type: number
                        description: The total number of Credit card transactions.
                        example: 26
                      amount:
                        type: string
                        description: The total amount of Credit card transactions.
                        example: '2300'
                  brand_breakdown:
                    type: array
                    items:
                      type: object
                      properties:
                        brand:
                          type: string
                          enum:
                            - VISA
                            - MASTERCARD
                            - AMEX
                            - DINERS
                            - DISCOVER
                            - JCB
                            - CUP
                          description: Indicates the card brand that this batch summary pertains to.
                          minLength: 1
                          maxLength: 50
                          example: VISA
                        amount:
                          type: string
                          description: The batch amount that is an aggregation of all the transactions' amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
                          example: '8300'
                        count:
                          type: number
                          description: The number of transactions in the batch for this brand.
                          example: 83
                        gratuity_amount:
                          type: string
                          description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
                          example: '500'
                        sales:
                          type: object
                          properties:
                            count:
                              type: number
                              description: The total number of Sale transactions for this brand.
                              example: 80
                            amount:
                              type: string
                              description: The total amount of Sale transactions for this brand.
                              example: '8000'
                        refunds:
                          type: object
                          properties:
                            count:
                              type: number
                              description: The total number of Refund transactions for this brand.
                              example: 3
                            amount:
                              type: string
                              description: The total amount of Refund transactions for this brand.
                              example: '300'
                        funding_debit:
                          type: object
                          properties:
                            count:
                              type: number
                              description: The total number of Debit card transactions for this brand.
                              example: 80
                            amount:
                              type: string
                              description: The total amount of Debit card transactions for this brand.
                              example: '8000'
                        funding_credit:
                          type: object
                          properties:
                            count:
                              type: number
                              description: The total number of Credit card transactions for this brand.
                              example: 3
                            amount:
                              type: string
                              description: The total amount of Credit card transactions for this brand.
                              example: '300'
                  action:
                    type: object
                    properties:
                      id:
                        type: string
                        description: A unique identifier generated by Global Payments to identify an action.
                        example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                      type:
                        type: string
                        enum:
                          - BATCH_SINGLE
                          - CLOSE
                        description: Indicates the specific action taken.
                        example: BATCH_SINGLE
                      time_created:
                        type: string
                        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
                        enum:
                          - SUCCESS
                        description: The result of the action executed.
                        minLength: 1
                        maxLength: 50
                        example: SUCCESS
                      app_id:
                        type: string
                        description: The id of the app that was used to create the token.
                        minLength: 1
                        maxLength: 50
                        example: uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
                      app_name:
                        type: string
                        description: The name of the app the user gave to the application.
                        minLength: 1
                        maxLength: 50
                        example: my_lovely_app
                x-examples: {}
          headers:
            Content-Type:
              schema:
                name: Content-type
                in: header
                required: true
                schema:
                  type: string
                  default: application/json
                  example: application/json
                description: Format of the message body.
            Content-Encoding:
              schema:
                name: Content-type
                in: header
                required: true
                schema:
                  type: string
                  default: application/json
                  example: application/json
                description: Format of the message body.
            X-GP-Version:
              schema:
                name: Content-type
                in: header
                required: true
                schema:
                  type: string
                  default: application/json
                  example: application/json
                description: Format of the message body.
            X-GP-Idempotency:
              schema:
                name: Content-type
                in: header
                required: true
                schema:
                  type: string
                  default: application/json
                  example: application/json
                description: Format of the message body.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: Bad Request
                properties:
                  error_code:
                    type: string
                    enum:
                      - DUPLICATE_TRANSACTION
                      - INVALID_BATCH_ACTION
                      - INVALID_REQUEST_DATA
                      - INVALID_TRANSACTION_ACTION
                      - MANDATORY_DATA_MISSING
                      - TRANSACTION_NOT_FOUND
                    description: This indicates an issue with the API request.
                    example: MANDATORY_DATA_MISSING
                  detailed_error_code:
                    type: string
                    enum:
                      - '40016'
                    description: Unique reference to identify the error.
                    example: '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:
                type: object
                description: Not Authenticated
                properties:
                  error_code:
                    type: string
                    enum:
                      - NOT_AUTHENTICATED
                    description: This action failed as token in the request is not valid.
                    example: NOT_AUTHENTICATED
                  detailed_error_code:
                    type: string
                    enum:
                      - '40001'
                      - '40002'
                    description: Unique reference to identify the error.
                    example: '40001'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Invalid Access Token
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: Forbidden
                properties:
                  error_code:
                    type: string
                    enum:
                      - ACTION_NOT_AUTHORIZED
                    description: This action is not authorized with the credentials being used.
                    example: ACTION_NOT_AUTHORIZED
                  detailed_error_code:
                    type: string
                    enum:
                      - '40003'
                      - '40004'
                    description: Unique reference to identify the error.
                    example: '40003'
                  detailed_error_description:
                    type: string
                    description: Unique Text describing the specific error.
                    example: Permission not enabled to execute action
        '404':
          description: Resource Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: Internal Server Error
                properties:
                  error_code:
                    type: string
                    enum:
                      - SYSTEM_ERROR_DOWNSTREAM
                    description: This indicates an unexpected issue occurred on the Global Payments system.
                    example: SYSTEM_ERROR_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    enum:
                      - '50011'
                    description: Unique reference to identify the error.
                    example: '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:
                type: object
                description: Not implemented
                properties:
                  error_code:
                    type: string
                    enum:
                      - UNKNOWN_RESPONSE
                    description: This is an error not yet handled or mapped properly.
                    example: UNKNOWN_RESPONSE
                  detailed_error_code:
                    type: string
                    enum:
                      - '50012'
                    description: Unique reference to identify the error.
                    example: '50012'
                  detailed_error_description:
                    type: string
                    description: 'Unique Text describing the specific error not yet handled.      '
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                description: Bad Gateway
                properties:
                  error_code:
                    type: string
                    enum:
                      - UNAUTHORIZED_DOWNSTREAM
                    description: This is an error indicating there was an issue connecting to a partner system..
                    example: UNAUTHORIZED_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    enum:
                      - '50002'
                    description: Unique reference to identify the error.
                    example: '50002'
                  detailed_error_description:
                    type: string
                    description: Authentication error—Verify and correct credentials.
        '504':
          description: Timeout
          content:
            application/json:
              schema:
                type: object
                description: Timeout
                properties:
                  error_code:
                    type: string
                    enum:
                      - TIMEOUT_DOWNSTREAM
                    description: This is an error indicating there was a timeout issue to another  system.
                    example: TIMEOUT_DOWNSTREAM
                  detailed_error_code:
                    type: string
                    enum:
                      - '50008'
                    description: Unique reference to identify the error.
                    example: '50008'
                  detailed_error_description:
                    type: string
                    description: No response from payment method provider.
      servers:
        - url: 'https://apis.sandbox.globalpay.com/ucp'
          description: Sandbox Environment
        - url: 'https://apis.globalpay.com/ucp'
          description: Production Environment
tags:
  - name: Get a Batch
  - name: Close a Batch
components:
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: Bearer access token value used to authorize and access the API.  Must always begin with the string "Bearer".
      required: true
      schema:
        type: string
        default: Bearer CdqyD9r7orAGau004u5NecG03JPy
        example: Bearer CdqyD9r7orAGau004u5NecG03JPy
    X-GP-Version:
      name: X-GP-Version
      in: header
      description: The version of the API to execute the request.
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 50
        default: '2021-03-22'
        example: '2021-03-22'
    Accept:
      name: Accept
      in: header
      description: Indicates the expected format of the message response.
      required: false
      schema:
        type: string
        default: application/json
  responses:
    RequestInvalid_400:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            description: Bad Request
            properties:
              error_code:
                type: string
                enum:
                  - DUPLICATE_TRANSACTION
                  - INVALID_BATCH_ACTION
                  - INVALID_REQUEST_DATA
                  - INVALID_TRANSACTION_ACTION
                  - MANDATORY_DATA_MISSING
                  - TRANSACTION_NOT_FOUND
                description: This indicates an issue with the API request.
                example: MANDATORY_DATA_MISSING
              detailed_error_code:
                type: string
                enum:
                  - '40016'
                description: Unique reference to identify the error.
                example: '40016'
              detailed_error_description:
                type: string
                description: Unique Text describing the specific error.
                example: Bad track data
    AuthenticationInvalid_401:
      description: Not Authenticated
      content:
        application/json:
          schema:
            type: object
            description: Not Authenticated
            properties:
              error_code:
                type: string
                enum:
                  - NOT_AUTHENTICATED
                description: This action failed as token in the request is not valid.
                example: NOT_AUTHENTICATED
              detailed_error_code:
                type: string
                enum:
                  - '40001'
                  - '40002'
                description: Unique reference to identify the error.
                example: '40001'
              detailed_error_description:
                type: string
                description: Unique Text describing the specific error.
                example: Invalid Access Token
    NotAuthorized_403:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            description: Forbidden
            properties:
              error_code:
                type: string
                enum:
                  - ACTION_NOT_AUTHORIZED
                description: This action is not authorized with the credentials being used.
                example: ACTION_NOT_AUTHORIZED
              detailed_error_code:
                type: string
                enum:
                  - '40003'
                  - '40004'
                description: Unique reference to identify the error.
                example: '40003'
              detailed_error_description:
                type: string
                description: Unique Text describing the specific error.
                example: Permission not enabled to execute action
    ServerError_500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            description: Internal Server Error
            properties:
              error_code:
                type: string
                enum:
                  - SYSTEM_ERROR_DOWNSTREAM
                description: This indicates an unexpected issue occurred on the Global Payments system.
                example: SYSTEM_ERROR_DOWNSTREAM
              detailed_error_code:
                type: string
                enum:
                  - '50011'
                description: Unique reference to identify the error.
                example: '50011'
              detailed_error_description:
                type: string
                description: Unique Text describing the specific error.
                example: Processor Configuration error
    UnknownServerError_501:
      description: Not implemented
      content:
        application/json:
          schema:
            type: object
            description: Not implemented
            properties:
              error_code:
                type: string
                enum:
                  - UNKNOWN_RESPONSE
                description: This is an error not yet handled or mapped properly.
                example: UNKNOWN_RESPONSE
              detailed_error_code:
                type: string
                enum:
                  - '50012'
                description: Unique reference to identify the error.
                example: '50012'
              detailed_error_description:
                type: string
                description: 'Unique Text describing the specific error not yet handled.      '
    UnknownPlatformError_502:
      description: Bad Gateway
      content:
        application/json:
          schema:
            type: object
            description: Bad Gateway
            properties:
              error_code:
                type: string
                enum:
                  - UNAUTHORIZED_DOWNSTREAM
                description: This is an error indicating there was an issue connecting to a partner system..
                example: UNAUTHORIZED_DOWNSTREAM
              detailed_error_code:
                type: string
                enum:
                  - '50002'
                description: Unique reference to identify the error.
                example: '50002'
              detailed_error_description:
                type: string
                description: Authentication error—Verify and correct credentials.
    ServerTimeout_504:
      description: Timeout
      content:
        application/json:
          schema:
            type: object
            description: Timeout
            properties:
              error_code:
                type: string
                enum:
                  - TIMEOUT_DOWNSTREAM
                description: This is an error indicating there was a timeout issue to another  system.
                example: TIMEOUT_DOWNSTREAM
              detailed_error_code:
                type: string
                enum:
                  - '50008'
                description: Unique reference to identify the error.
                example: '50008'
              detailed_error_description:
                type: string
                description: No response from payment method provider.
  schemas:
    id_BATCHES.id:
      type: string
      description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
      minLength: 1
      maxLength: 50
      example: BAT_855049-899
    GetResponse:
      type: object
      title: GetResponse
      properties:
        id:
          type: string
          description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
          minLength: 1
          maxLength: 50
          example: BAT_855049-899
        status:
          type: string
          description: |
            Indicates where a batch is in its life cycle. *`OPEN` - Batch is open and can accept more transactions.
            *`CLOSED` - Batch is closed and cannot accept more transactions.
          example: OPEN
        time_created:
          type: string
          description: Global Payments time indicating when the object was created in ISO-8601 format..
          minLength: 1
          maxLength: 50
          example: '2021-05-03T21:23:39.718Z'
        time_closed:
          type: string
          description: Global Payments generated time indicating when the batch was closed
          minLength: 1
          maxLength: 50
          example: '2021-05-03T21:23:39.718Z'
        open_action_id:
          type: string
          description: An identifier generated by Global Payments to uniquely identify the action that opened the batch.
          minLength: 1
          maxLength: 50
          example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
        close_action_id:
          type: string
          description: An identifier generated by Global Payments to uniquely identify the action that closed the batch.
          minLength: 1
          maxLength: 50
          example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
        merchant_id:
          type: string
          description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific merchant. Begins with the three letters, MER.'
          minLength: 1
          maxLength: 50
          example: MER_A6A1EC44522F96630ABEA17A
        merchant_name:
          type: string
          description: A meaningful label that better identifies the merchant.
          minLength: 1
          maxLength: 50
          example: ABC INDUSTRIES
        account_id:
          type: string
          description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific account. Begins with the three letters, TRA.'
          minLength: 1
          maxLength: 50
          example: TRA_86920f927028745yt34d077d88beb29b
        account_name:
          type: string
          description: A meaningful label that better identifies the account.
          minLength: 1
          maxLength: 50
          example: transaction_processing
        site_reference:
          type: string
          description: A reference for the location that created the batch.
          minLength: 1
          maxLength: 50
        device_reference:
          type: string
          description: A reference for the device that created the batch
          minLength: 1
          maxLength: 50
        batch_transaction_count:
          type: number
          description: The number of transactions in the batch.
          example: 126
        amount:
          type: string
          description: The batch amount that is an aggregation of all the transactions' amounts in the batch. It is always represented in the lowest denomination of the related currency.
          example: '12000'
        currency:
          type: string
          description: The currency of the amount in ISO-4217(alpha-3)
          minLength: 3
          maxLength: 3
          example: USD
        gratuity_amount:
          type: string
          description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch. It is always represented in the lowest denomination of the related currency.
          example: '500'
        sales:
          type: object
          properties:
            count:
              type: number
              description: The total number of Sale transactions.
              example: 123
            amount:
              type: string
              description: The total amount of Sale transactions.
              example: '12300'
        refunds:
          type: object
          properties:
            count:
              type: number
              description: The total number of Refund transactions.
              example: 3
            amount:
              type: string
              description: The total amount of Refund transactions.
              example: '300'
        funding_debit:
          type: object
          properties:
            count:
              type: number
              description: The total number of Debit card transactions.
              example: 100
            amount:
              type: string
              description: The total amount of Debit card transactions.
              example: '10000'
        funding_credit:
          type: object
          properties:
            count:
              type: number
              description: The total number of Credit card transactions.
              example: 26
            amount:
              type: string
              description: The total amount of Credit card transactions.
              example: '2300'
        brand_breakdown:
          type: array
          items:
            type: object
            properties:
              brand:
                type: string
                enum:
                  - VISA
                  - MASTERCARD
                  - AMEX
                  - DINERS
                  - DISCOVER
                  - JCB
                  - CUP
                description: Indicates the card brand that this batch summary pertains to.
                minLength: 1
                maxLength: 50
                example: VISA
              amount:
                type: string
                description: The batch amount that is an aggregation of all the transactions' amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
                example: '8300'
              count:
                type: number
                description: The number of transactions in the batch for this brand.
                example: 83
              gratuity_amount:
                type: string
                description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
                example: '500'
              sales:
                type: object
                properties:
                  count:
                    type: number
                    description: The total number of Sale transactions for this brand.
                    example: 80
                  amount:
                    type: string
                    description: The total amount of Sale transactions for this brand.
                    example: '8000'
              refunds:
                type: object
                properties:
                  count:
                    type: number
                    description: The total number of Refund transactions for this brand.
                    example: 3
                  amount:
                    type: string
                    description: The total amount of Refund transactions for this brand.
                    example: '300'
              funding_debit:
                type: object
                properties:
                  count:
                    type: number
                    description: The total number of Debit card transactions for this brand.
                    example: 80
                  amount:
                    type: string
                    description: The total amount of Debit card transactions for this brand.
                    example: '8000'
              funding_credit:
                type: object
                properties:
                  count:
                    type: number
                    description: The total number of Credit card transactions for this brand.
                    example: 3
                  amount:
                    type: string
                    description: The total amount of Credit card transactions for this brand.
                    example: '300'
        action:
          type: object
          properties:
            id:
              type: string
              description: A unique identifier generated by Global Payments to identify an action.
              example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
            type:
              type: string
              enum:
                - BATCH_SINGLE
                - CLOSE
              description: Indicates the specific action taken.
              example: BATCH_SINGLE
            time_created:
              type: string
              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
              enum:
                - SUCCESS
              description: The result of the action executed.
              minLength: 1
              maxLength: 50
              example: SUCCESS
            app_id:
              type: string
              description: The id of the app that was used to create the token.
              minLength: 1
              maxLength: 50
              example: uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
            app_name:
              type: string
              description: The name of the app the user gave to the application.
              minLength: 1
              maxLength: 50
              example: my_lovely_app
      x-examples: {}
    status_BATCHES.status:
      type: string
      description: |
        Indicates where a batch is in its life cycle. *`OPEN` - Batch is open and can accept more transactions.
        *`CLOSED` - Batch is closed and cannot accept more transactions.
      example: OPEN
    time_created_BATCHES.time_created:
      type: string
      description: Global Payments time indicating when the object was created in ISO-8601 format..
      minLength: 1
      maxLength: 50
      example: '2021-05-03T21:23:39.718Z'
    time_closed_BATCHES.time_closed:
      type: string
      description: Global Payments generated time indicating when the batch was closed
      minLength: 1
      maxLength: 50
      example: '2021-05-03T21:23:39.718Z'
    open_action_id_BATCHES.open_action_id:
      type: string
      description: An identifier generated by Global Payments to uniquely identify the action that opened the batch.
      minLength: 1
      maxLength: 50
      example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
    close_action_id_BATCHES.close_action_id:
      type: string
      description: An identifier generated by Global Payments to uniquely identify the action that closed the batch.
      minLength: 1
      maxLength: 50
      example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
    merchant_id_BATCHES.merchant_id:
      type: string
      description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific merchant. Begins with the three letters, MER.'
      minLength: 1
      maxLength: 50
      example: MER_A6A1EC44522F96630ABEA17A
    merchant_name_BATCHES.merchant_name:
      type: string
      description: A meaningful label that better identifies the merchant.
      minLength: 1
      maxLength: 50
      example: ABC INDUSTRIES
    account_id_BATCHES.account_id:
      type: string
      description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific account. Begins with the three letters, TRA.'
      minLength: 1
      maxLength: 50
      example: TRA_86920f927028745yt34d077d88beb29b
    account_name_BATCHES.account_name:
      type: string
      description: A meaningful label that better identifies the account.
      minLength: 1
      maxLength: 50
      example: transaction_processing
    site_reference_BATCHES.site_reference:
      type: string
      description: A reference for the location that created the batch.
      minLength: 1
      maxLength: 50
    device_reference_BATCHES.device_reference:
      type: string
      description: A reference for the device that created the batch
      minLength: 1
      maxLength: 50
    batch_transaction_count_BATCHES.batch_transaction_count:
      type: number
      description: The number of transactions in the batch.
      example: 126
    amount_BATCHES.amount:
      type: string
      description: The batch amount that is an aggregation of all the transactions' amounts in the batch. It is always represented in the lowest denomination of the related currency.
      example: '12000'
    currency_BATCHES.currency:
      type: string
      description: The currency of the amount in ISO-4217(alpha-3)
      minLength: 3
      maxLength: 3
      example: USD
    gratuity_amount_BATCHES.gratuity_amount:
      type: string
      description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch. It is always represented in the lowest denomination of the related currency.
      example: '500'
    count_BATCHES.sales.count:
      type: number
      description: The total number of Sale transactions.
      example: 123
    amount_BATCHES.sales.amount:
      type: string
      description: The total amount of Sale transactions.
      example: '12300'
    count_BATCHES.refunds.count:
      type: number
      description: The total number of Refund transactions.
      example: 3
    amount_BATCHES.refunds.amount:
      type: string
      description: The total amount of Refund transactions.
      example: '300'
    count_BATCHES.funding_debit.count:
      type: number
      description: The total number of Debit card transactions.
      example: 100
    amount_BATCHES.funding_debit.amount:
      type: string
      description: The total amount of Debit card transactions.
      example: '10000'
    count_BATCHES.funding_credit.count:
      type: number
      description: The total number of Credit card transactions.
      example: 26
    amount_BATCHES.funding_credit.amount:
      type: string
      description: The total amount of Credit card transactions.
      example: '2300'
    brand_breakdown_item:
      type: object
      properties:
        brand:
          type: string
          enum:
            - VISA
            - MASTERCARD
            - AMEX
            - DINERS
            - DISCOVER
            - JCB
            - CUP
          description: Indicates the card brand that this batch summary pertains to.
          minLength: 1
          maxLength: 50
          example: VISA
        amount:
          type: string
          description: The batch amount that is an aggregation of all the transactions' amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
          example: '8300'
        count:
          type: number
          description: The number of transactions in the batch for this brand.
          example: 83
        gratuity_amount:
          type: string
          description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
          example: '500'
        sales:
          type: object
          properties:
            count:
              type: number
              description: The total number of Sale transactions for this brand.
              example: 80
            amount:
              type: string
              description: The total amount of Sale transactions for this brand.
              example: '8000'
        refunds:
          type: object
          properties:
            count:
              type: number
              description: The total number of Refund transactions for this brand.
              example: 3
            amount:
              type: string
              description: The total amount of Refund transactions for this brand.
              example: '300'
        funding_debit:
          type: object
          properties:
            count:
              type: number
              description: The total number of Debit card transactions for this brand.
              example: 80
            amount:
              type: string
              description: The total amount of Debit card transactions for this brand.
              example: '8000'
        funding_credit:
          type: object
          properties:
            count:
              type: number
              description: The total number of Credit card transactions for this brand.
              example: 3
            amount:
              type: string
              description: The total amount of Credit card transactions for this brand.
              example: '300'
    brand_BATCHES.brand_breakdown.brand:
      type: string
      enum:
        - VISA
        - MASTERCARD
        - AMEX
        - DINERS
        - DISCOVER
        - JCB
        - CUP
      description: Indicates the card brand that this batch summary pertains to.
      minLength: 1
      maxLength: 50
      example: VISA
    amount_BATCHES.brand_breakdown.amount:
      type: string
      description: The batch amount that is an aggregation of all the transactions' amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
      example: '8300'
    count_BATCHES.brand_breakdown.count:
      type: number
      description: The number of transactions in the batch for this brand.
      example: 83
    gratuity_amount_BATCHES.brand_breakdown.gratuity_amount:
      type: string
      description: The amount that is an aggregation of all the transactions' gratuity amounts in the batch for this brand. It is always represented in the lowest denomination of the related currency.
      example: '500'
    count_BATCHES.brand_breakdown.sales.count:
      type: number
      description: The total number of Sale transactions for this brand.
      example: 80
    amount_BATCHES.brand_breakdown.sales.amount:
      type: string
      description: The total amount of Sale transactions for this brand.
      example: '8000'
    count_BATCHES.brand_breakdown.refunds.count:
      type: number
      description: The total number of Refund transactions for this brand.
      example: 3
    amount_BATCHES.brand_breakdown.refunds.amount:
      type: string
      description: The total amount of Refund transactions for this brand.
      example: '300'
    count_BATCHES.brand_breakdown.funding_debit.count:
      type: number
      description: The total number of Debit card transactions for this brand.
      example: 80
    amount_BATCHES.brand_breakdown.funding_debit.amount:
      type: string
      description: The total amount of Debit card transactions for this brand.
      example: '8000'
    count_BATCHES.brand_breakdown.funding_credit.count:
      type: number
      description: The total number of Credit card transactions for this brand.
      example: 3
    amount_BATCHES.brand_breakdown.funding_credit.amount:
      type: string
      description: The total amount of Credit card transactions for this brand.
      example: '300'
    id_BATCHES.action.id:
      type: string
      description: A unique identifier generated by Global Payments to identify an action.
      example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
    type_BATCHES.action.type:
      type: string
      enum:
        - BATCH_SINGLE
        - CLOSE
      description: Indicates the specific action taken.
      example: BATCH_SINGLE
    time_created_BATCHES.action.time_created:
      type: string
      description: Global Payments time indicating when the object was created in ISO-8601 format.
      example: '2021-05-03T21:23:39.718Z'
    result_code_BATCHES.action.result_code:
      type: string
      enum:
        - SUCCESS
      description: The result of the action executed.
      minLength: 1
      maxLength: 50
      example: SUCCESS
    app_id_BATCHES.action.app_id:
      type: string
      description: The id of the app that was used to create the token.
      minLength: 1
      maxLength: 50
      example: uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
    app_name_BATCHES.action.app_name:
      type: string
      description: The name of the app the user gave to the application.
      minLength: 1
      maxLength: 50
      example: my_lovely_app
    objRequestInvalid_400:
      type: object
      description: Bad Request
      properties:
        error_code:
          type: string
          enum:
            - DUPLICATE_TRANSACTION
            - INVALID_BATCH_ACTION
            - INVALID_REQUEST_DATA
            - INVALID_TRANSACTION_ACTION
            - MANDATORY_DATA_MISSING
            - TRANSACTION_NOT_FOUND
          description: This indicates an issue with the API request.
          example: MANDATORY_DATA_MISSING
        detailed_error_code:
          type: string
          enum:
            - '40016'
          description: Unique reference to identify the error.
          example: '40016'
        detailed_error_description:
          type: string
          description: Unique Text describing the specific error.
          example: Bad track data
    AuthenticationInvalid_401:
      type: object
      description: Not Authenticated
      properties:
        error_code:
          type: string
          enum:
            - NOT_AUTHENTICATED
          description: This action failed as token in the request is not valid.
          example: NOT_AUTHENTICATED
        detailed_error_code:
          type: string
          enum:
            - '40001'
            - '40002'
          description: Unique reference to identify the error.
          example: '40001'
        detailed_error_description:
          type: string
          description: Unique Text describing the specific error.
          example: Invalid Access Token
    NotAuthorized_403:
      type: object
      description: Forbidden
      properties:
        error_code:
          type: string
          enum:
            - ACTION_NOT_AUTHORIZED
          description: This action is not authorized with the credentials being used.
          example: ACTION_NOT_AUTHORIZED
        detailed_error_code:
          type: string
          enum:
            - '40003'
            - '40004'
          description: Unique reference to identify the error.
          example: '40003'
        detailed_error_description:
          type: string
          description: Unique Text describing the specific error.
          example: Permission not enabled to execute action
    ServerError_500:
      type: object
      description: Internal Server Error
      properties:
        error_code:
          type: string
          enum:
            - SYSTEM_ERROR_DOWNSTREAM
          description: This indicates an unexpected issue occurred on the Global Payments system.
          example: SYSTEM_ERROR_DOWNSTREAM
        detailed_error_code:
          type: string
          enum:
            - '50011'
          description: Unique reference to identify the error.
          example: '50011'
        detailed_error_description:
          type: string
          description: Unique Text describing the specific error.
          example: Processor Configuration error
    UnknownServerError_501:
      type: object
      description: Not implemented
      properties:
        error_code:
          type: string
          enum:
            - UNKNOWN_RESPONSE
          description: This is an error not yet handled or mapped properly.
          example: UNKNOWN_RESPONSE
        detailed_error_code:
          type: string
          enum:
            - '50012'
          description: Unique reference to identify the error.
          example: '50012'
        detailed_error_description:
          type: string
          description: 'Unique Text describing the specific error not yet handled.      '
    UnknownPlatformError_502:
      type: object
      description: Bad Gateway
      properties:
        error_code:
          type: string
          enum:
            - UNAUTHORIZED_DOWNSTREAM
          description: This is an error indicating there was an issue connecting to a partner system..
          example: UNAUTHORIZED_DOWNSTREAM
        detailed_error_code:
          type: string
          enum:
            - '50002'
          description: Unique reference to identify the error.
          example: '50002'
        detailed_error_description:
          type: string
          description: Authentication error—Verify and correct credentials.
    ServerTimeout_504:
      type: object
      description: Timeout
      properties:
        error_code:
          type: string
          enum:
            - TIMEOUT_DOWNSTREAM
          description: This is an error indicating there was a timeout issue to another  system.
          example: TIMEOUT_DOWNSTREAM
        detailed_error_code:
          type: string
          enum:
            - '50008'
          description: Unique reference to identify the error.
          example: '50008'
        detailed_error_description:
          type: string
          description: No response from payment method provider.