Paths
/v1/channels/bne/authenticate/login
This API is to authenticate customer
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
2 character ISO country code
{
"default": "MX"
}3 character business code
{
"default": "GCB"
}channel ID used by the user, it is required for the first call in a new session.
The client ID you received during application registration in the developer portal
Bearer token aquired from APIM token endpoint
Content-Types that are sent in the request
{
"default": "application\/json"
}This request is to authenticate customer
Authentication Successful
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | userAccountNotActive | 180-account not active |
| error | userAccountLocked | 15-account locked | error | passwordExpired | 9-password has expired |
| error | credentialValidationFailed | 20-master validation failure |
| error | cannotDecryptData | 620-Cannot decrypt, please re-check the encrypted value |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability | fatal | backendError | Failed during a call to backend service |
This API will logout the customer from NGA and S15 session. Session id will become invalid after this is succesful
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
2 character ISO country code
{
"default": "MX"
}3 character business code
{
"default": "GCB"
}channel ID used by the user, it is required for the first call in a new session.
The client ID you received during application registration in the developer portal
Bearer token aquired from APIM token endpoint
Success Response, Logout Success
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability | fatal | backendError | Failed during a call to backend service |
/v1/channels/bne/authenticate/keepalive
This API is keeps the session alive of PSG and S15
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
2 character ISO country code
{
"default": "MX"
}3 character business code
{
"default": "GCB"
}channel ID used by the user, it is required for the first call in a new session.
The client ID you received during application registration in the developer portal
Bearer token aquired from APIM token endpoint
Success Response
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability | fatal | backendError | Failed during a call to backend service |
/v1/channels/bne/authenticate/password
This API is used to change the password of customer
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
2 character ISO country code
{
"default": "MX"
}3 character business code
{
"default": "GCB"
}channel ID used by the user, it is required for the first call in a new session.
The client ID you received during application registration in the developer portal
Bearer token aquired from APIM token endpoint
Content-Types that are sent in the request
{
"default": "application\/json"
}This request is to change customer password
Success Response, Password is changed.
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | cannotDecryptData | 620-Cannot decrypt, please re-check the encrypted value. |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability | fatal | backendError | Failed during a call to backend service |
/v1/channels/bne/authenticate/unlock
This API is used to unlock a locked customer
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
2 character ISO country code
{
"default": "MX"
}3 character business code
{
"default": "GCB"
}channel ID used by the user, it is required for the first call in a new session.
The client ID you received during application registration in the developer portal
Bearer token aquired from APIM token endpoint
Content-Types that are sent in the request
{
"default": "application\/json"
}This request is to unlock a locked customer
Success Response
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability | fatal | backendError | Failed during a call to backend service |
/v1/channels/bne/authenticate/challenge/get
This API is used to get a challenge code for authenticating a customer
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
2 character ISO country code
{
"default": "MX"
}3 character business code
{
"default": "GCB"
}channel ID used by the user, it is required for the first call in a new session.
The client ID you received during application registration in the developer portal
Bearer token aquired from APIM token endpoint
This request is to get customer challenge
Success Response
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability | fatal | backendError | Failed during a call to backend service |
/v1/channels/bne/authenticate/challenge/validate
This API is to authenticate customer with challenge code
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
2 character ISO country code
{
"default": "MX"
}3 character business code
{
"default": "GCB"
}channel ID used by the user, it is required for the first call in a new session.
The client ID you received during application registration in the developer portal
Bearer token aquired from APIM token endpoint
Content-Types that are sent in the request
{
"default": "application\/json"
}This request is to validate customer challenge
Success Response
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability | fatal | backendError | Failed during a call to backend service |
Definitions
{
"properties": {
"validationCode": {
"description": "Validation code generated by hardware token",
"type": "string"
}
},
"required": [
"validationCode"
]
}
{
"properties": {
"customerId": {
"type": "string",
"description": "provide customer id of the customer"
},
"legalRepresentativeId": {
"description": "unique legal representative id",
"type": "string"
}
},
"required": [
"customerId",
"legalRepresentativeId"
]
}
{
"properties": {
"challengeCode": {
"description": "Challenge code generated at server",
"type": "string"
},
"expiry": {
"description": "Challenge code expiry time",
"type": "string"
}
}
}
{
"properties": {
"newPassword": {
"description": "New Password to set",
"type": "string"
},
"oldPassword": {
"description": "Old Password",
"type": "string"
}
},
"required": [
"newPassword",
"oldPassword"
]
}
{
"properties": {
"customerId": {
"description": "Unique Id for Customer",
"type": "string"
},
"legalRepresentativeId": {
"description": "Unique Id for representative",
"type": "string"
},
"validationCode": {
"description": "Validation code generated by hardware token",
"type": "string"
}
},
"required": [
"customerId",
"legalRepresentativeId",
"validationCode"
]
}
{
"properties": {
"customerCredentials": {
"$ref": "#/definitions/CustomerCredentials"
},
"sessionRequired": {
"description": "true if session is required to be opened with s15",
"type": "boolean",
"default": true
}
}
}
{
"properties": {
"challengeCode": {
"description": "Challenge code generated at server",
"type": "string"
},
"expiry": {
"description": "Challenge code expiry time",
"type": "string"
}
}
}
{
"properties": {
"customerId": {
"description": "Unique Id for Customer",
"type": "string"
},
"legalRepresentativeId": {
"description": "Unique Id for representative",
"type": "string"
},
"password": {
"description": "Customer password",
"type": "string"
},
"customerCategoryType": {
"description": "Catagory of the customer required during Login",
"type": "string"
}
},
"required": [
"customerId",
"password"
]
}
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "string"
}
},
"required": [
"type",
"code",
"details"
]
}