LogOff - CitiBanamexPay

LogOff - CitiBanamexPay 1.0.0-rev1

0
No votes yet
User Federated User

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.

forum Discuss this API in the forum
production
development
https://api.banamex.com/mx-gcgapi

Paths

/v1/private/auth

delete /v1/private/auth
Log Off

NGA Log Off API

This API needs to be used to Log Off from NGA Sesison based on SID in header

To use this operation you must use one of the following sets of security requirements.
ClientID (Query)
client_id
(apiKey located in query)

ClientID

OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)

OAuth Client Credentials Grant Type

Token URL
https://api.banamex.com/mx-gcgapi/api/oauth/token
Scopes
/api
Default scope
ClientID
X-IBM-Client-Id
(apiKey located in header)

ClientID

OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)

OAuth Client Credentials Grant Type

Token URL
https://api.banamex.com/mx-gcgapi/api/oauth/token
Scopes
/api
Default scope
uuid
Required in header
string

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.

{
    "default": "a7d1e304-83a9-4413-af97-62615e57eae66807840"
}
Accept
Required in header
string

Content-Types that are acceptable for the response. Currently we support application/json

{
    "default": "application\/json"
}
Accept-Language
Required in header
string

HTTP Accept-Language header

{
    "default": "en-US"
}
countryCode
Required in header
string

2 character ISO country code

{
    "default": "AU"
}
businessCode
Required in header
string

3 character business code

{
    "default": "GCB"
}
channelId
Required in header
string

channel ID used by the user

{
    "default": "CML"
}
client_id
Required in header
string

The client ID you received during application registration in the developer portal

{
    "default": "29738e5a-fbbf-4b55-981d-d2f3d2a60605"
}
client_secret
Optional in header
string

Client Secret generated during application registration

{
    "default": "iX4xW5lG0gD6cX3uI5qN3pF6yK5nY2kB0eY5tB3xQ4rD4fD2xO"
}
sid
Required in header
string

sid

{
    "default": "abbb4837-8343-418c-93d8-77a8519dff9e"
}
200

LogOff is successful

400

(BAD REQUEST) - Request was not processed

TypeCodeDetails
invalidinvalidRequestMissing Parameters

ErrorResponse
500

(INTERNAL SERVER ERROR) - API Server Error

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability

ErrorResponse
Example Request
Example Response
DELETE https://api.banamex.com/mx-gcgapi/api/v1/private/auth

Definitions 

{
    "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"
        }
    }
}