---
swagger: "2.0"
info:
  version: 1.0.0-rev1
  title: LogOff - CitiBanamexPay
  description: These API's are used to establish a profile in CCS with userID/password
    credentials and use a federated profile in CCS that is tied to the userID/password
    credentials.. These APIs support functions such as adding a new user, validating
    user credentials, changing userID/password, recovering userID, resetting password,
    mobile snapshot login etc.
  x-ibm-name: logoff---citibanamexpay
  name: ""
basePath: /api
schemes:
- https
x-ibm-configuration:
  enforced: true
  phase: realized
  testable: false
  externalDocs: []
  attachments: []
tags:
- name: User
  description: ""
- name: Federated User
  description: ""
definitions:
  ErrorResponse:
    required:
    - type
    - code
    properties:
      type:
        type: string
        enum:
        - error
        - warn
        - invalid
        - fatal
        description: <br>invalid - Request did not confirm to the specification and
          was unprocessed & rejected. Please fix the value and try again</br>                         <br>warn
          - Request was partially processed.  E.g. some of the fields are missing
          in response to the system issues,  request was accepted successfully but
          will be processed asynchronously</br>                                                           <br>error
          - The request was accepted but could not be processed successfully</br>            <br>fatal
          - There was an internal system error while processing the request. These
          are technical errors and will be resolved by Citi, and the consumer should
          retry after some time. Business errors will not be categorized as fatal
          </br>
      code:
        type: string
        description: Error code which qualifies the error
      details:
        type: string
        description: Human readable explanation specific to the occurrence of the
          problem
      location:
        type: string
        description: The name of the field that resulted in the error
      moreInfo:
        type: string
        description: URI to human readable documentation of the error
securityDefinitions:
  ClientID:
    type: apiKey
    name: X-IBM-Client-Id
    in: header
    description: ClientID
  ClientID (Query):
    type: apiKey
    name: client_id
    in: query
    description: ClientID
  OAuth2 Application Flow:
    type: oauth2
    flow: application
    scopes:
      /api: Default scope
    tokenUrl: https://api.banamex.com/mx-gcgapi/api/oauth/token
    description: OAuth Client Credentials Grant Type
paths:
  /v1/private/auth:
    delete:
      description: This API needs to be used to Log Off from NGA Sesison based on
        SID in header
      tags:
      - Log Off
      summary: NGA Log Off API
      parameters:
      - default: a7d1e304-83a9-4413-af97-62615e57eae66807840
        description: A 128 bit universally unique identifier (UUID) that you generate
          for every request and is used for tracking. It is recommended to use the
          output from Java UUID class or an equivalent.
        name: uuid
        required: true
        type: string
        in: header
      - default: application/json
        description: Content-Types that are acceptable for the response. Currently
          we support application/json
        name: Accept
        required: true
        type: string
        in: header
      - default: en-US
        description: HTTP Accept-Language header
        name: Accept-Language
        required: true
        type: string
        in: header
      - default: AU
        description: 2 character ISO country code
        name: countryCode
        required: true
        type: string
        in: header
      - default: GCB
        description: 3 character business code
        name: businessCode
        required: true
        type: string
        in: header
      - default: CML
        description: channel ID used by the user
        name: channelId
        required: true
        type: string
        in: header
      - default: 29738e5a-fbbf-4b55-981d-d2f3d2a60605
        description: The client ID  you received during application registration in
          the developer portal
        name: client_id
        required: true
        type: string
        in: header
      - default: iX4xW5lG0gD6cX3uI5qN3pF6yK5nY2kB0eY5tB3xQ4rD4fD2xO
        description: Client Secret generated during application registration
        name: client_secret
        required: false
        type: string
        in: header
      - default: abbb4837-8343-418c-93d8-77a8519dff9e
        description: sid
        name: sid
        required: true
        type: string
        in: header
      responses:
        200:
          description: 'LogOff is successful '
        400:
          description: (BAD REQUEST) - Request was not processed <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: (INTERNAL SERVER ERROR) - API Server Error <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
      security:
      - ClientID (Query): []
        OAuth2 Application Flow:
        - /api
      - ClientID: []
        OAuth2 Application Flow:
        - /api
security:
- ClientID (Query): []
  OAuth2 Application Flow:
  - /api
- ClientID: []
  OAuth2 Application Flow:
  - /api
x-ibm-endpoints:
- endpointUrl: https://api.banamex.com/mx-gcgapi
  type:
  - production
  - development
...