---
swagger: "2.0"
info:
title: Customer Sessions Information
description: This API will be used in Customer Scope to get the Session Data from
Legacy Systems.It should be called after proper authentication of the sustomer
data and opening a session with S15 in any of the previous call
version: 1.0.0
x-ibm-name: customer-sessions-information
basePath: /api
schemes:
- https
paths:
/v1/x-global/customers/session/info:
get:
summary: Get the Session Data from legacy systems.
tags:
- Customer Sessions Info
responses:
200:
description: Session Data Retrieved Successfully
schema:
$ref: '#/definitions/GetLegacySessionResponse'
400:
description: (BAD REQUEST) - Request was not processed
Type | Code | Details |
invalid | invalidRequest | Missing
Parameters |
invalid | notAvailable | Session
Data is Not Available for this Customer |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: ' Unauthorized - Client must authenticate itself to get the
requested response Type | Code | Details |
error | unAuthorized | Authorization
credentials are missing or invalid |
'
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: (FORBIDDEN) - Unauthorized to perform the requested operation
on resource Type | Code | Details | More
Info |
invalid | accessNotConfigured | The
request operation is not configured to access this resource | Channel/Country/Business
provided in the request is not supported currently |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: (Not Found) - The requested resource could not be found but
may be available in the future. Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: (INTERNAL SERVER ERROR) - API Server Error Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
consumes:
- application/json
produces:
- application/json
parameters:
- name: uuid
default: a7d1e304-83a9-4413-af97-62615e57eae66807840
in: header
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. If not provided by APP, PSG
will generate it.
required: true
type: string
- name: Accept
default: application/json
in: header
description: Content-Types that are acceptable for the response. Currently
we support application/json.If not provided by APP, PSG will generate it.
required: true
type: string
- name: Content-Type
default: application/json
in: header
description: This is the HTTP Content-Type.If not provided by APP, PSG will
generate it.
required: true
type: string
- name: Accept-Language
default: en-US
in: header
description: HTTP Accept-Language header.If not provided by APP, PSG will
add default.
required: true
type: string
- name: countryCode
default: MX
in: header
description: 2 character ISO country code.If not provided by APP, PSG will
add default
required: true
type: string
- name: businessCode
default: GCB
in: header
description: business code.If not provided by APP, PSG will add default
required: true
type: string
- name: channelId
in: header
description: Channel Id identifies the consumer from where the request comes
required: true
type: string
- name: sid
default: abbb4837-8343-418c-93d8-77a8519dff9e
in: header
description: sid
required: true
type: string
- name: Authorization
default: asdfkjsaldfjasfiewetowtllasgflasfspfwerfjwejrowglklasdfaslf
in: header
description: The Authorization Token received during login.The scope will
be limited till APIGateway.
required: true
type: string
- name: client_id
default: 29738e5a-fbbf-4b55-981d-d2f3d2a60605
in: header
description: The client ID you received during application registration in
the developer portal.The scope will be limited till APIGateway.
required: true
type: string
definitions:
GetLegacySessionResponse:
type: object
properties:
stationNumber:
description: stationNumber
type: integer
example: 5739
maxLength: 4
stationName:
description: stationName
type: string
example: T086N20
maxLength: 8
serviceTransactionId:
description: transactionId
type: integer
example: 100100
maxLength: 6
messageIndex:
description: index number of the message
type: integer
example: 456001
maxLength: 6
stationSessionCount:
description: Customer Id
type: integer
example: 1
maxLength: 2
dataCenterLocation:
description: Data Center location (CSI)
type: string
example: 10
agentSessionFlag:
description: agentSessionFlag
type: integer
example: 2
maxLength: 1
customerSessionFlag:
description: customerSessionFlag
type: integer
example: 2
maxLength: 1
branchId:
description: branchId
type: integer
example: 1000
maxLength: 4
agentId:
description: agentId
type: integer
example: 1234
maxLength: 4
allowedServiceTransactionCode:
description: allowedTransactionCode
type: integer
example: 3
maxLength: 2
ipAddress:
description: ipAddress
type: string
example: 1.0.0.1
maxLength: 15
ipType:
description: ipType
type: integer
example: 1
maxLength: 2
lastAccessDate:
description: lastAccessDate
type: string
format: date
example: "20180806"
maxLength: 8
lastAccessTime:
description: lastAccessTime
type: integer
example: 213515
maxLength: 6
lastChannelId:
description: last channel Id
type: string
example: 123456ABC
maxLength: 20
userCapabilities:
type: array
items:
$ref: '#/definitions/UserCapabilities'
respresentativeService:
type: array
items:
$ref: '#/definitions/RepresentativeService'
required:
- stationNumber
- stationName
- serviceTransactionId
- messageIndex
- stationSessionCount
- agentSessionFlag
- customerSessionFlag
- branchId
- agentId
- allowedServiceTransactionCode
- ipAddress
- ipType
- lastAccessDate
- lastAccessTime
- lastChannelId
UserCapabilities:
type: object
properties:
currencyCode:
description: currencyCode
type: integer
example: 1
maxLength: 2
dailyTransactionThreshold:
description: individualDailyTransactionThreshold
type: number
format: double
example: 99999999999999.984375
maxLength: 14
jointDailyTransactionThreshold:
description: jointDailyTransactionThreshold
type: number
format: double
example: 99999999999999.984375
maxLength: 14
frequencyTransactionThreshold:
description: periodTransactionThreshold
type: number
format: double
example: 99999999999999.984375
maxLength: 14
frequencyCode:
description: periodCode
type: integer
example: 1
maxLength: 2
transactionCategoryCode:
description: transactionCategoryCode
type: integer
example: 1
maxLength: 2
transactionClassification:
description: transactionClassification
type: integer
example: 10000009
maxLength: 8
required:
- currencyCode
- dailyTransactionThreshold
- jointDailyTransactionThreshold
- frequencyTransactionThreshold
- frequencyCode
- transactionCategoryCode
- transactionClassification
RepresentativeService:
type: object
properties:
customerServiceNumber:
description: customerServiceNumber
type: integer
example: 5544
maxLength: 4
customerCategoryType:
description: customerCategoryType
type: integer
example: 20
maxLength: 2
serviceStatus:
description: serviceStatus
type: integer
example: 1
maxLength: 2
representativeIndex:
description: Representative Index
type: integer
example: 1
maxLength: 2
required:
- customerServiceNumber
- customerCategoryType
- serviceStatus
- representativeIndex
ErrorResponse:
required:
- type
- code
properties:
type:
type: string
enum:
- error
- warn
- invalid
- fatal
description:
invalid - Request did not confirm to the specification and
was unprocessed & rejected. Please fix the value and try again
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
error
- The request was accepted but could not be processed successfully
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
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
x-ibm-configuration:
enforced: true
testable: true
phase: realized
security:
- OAuth2 Application Flow:
- /api/v1
Client ID: []
securityDefinitions:
OAuth2 Application Flow:
type: oauth2
description: ""
flow: application
scopes:
/api/v1: ""
tokenUrl: https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Client ID:
type: apiKey
description: ""
in: header
name: X-IBM-Client-Id
x-ibm-endpoints:
- endpointUrl: https://api.banamex.com/mx-gcgapi
type:
- production
- development
...