production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/codi-banxico/settings/detail
post /v1/customers/codi-banxico/settings/detail
save-customer-codi-settings-detail
LOB: Traditional Payments, Feature: Codi Settings, Functionality: Save information.
This API is used to save information changes to setting on mobile device.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
saveCustomerSettingsRequest
Optional in body
object
204
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/codi-banxico/settings/detail
Definitions
{
"type": "object",
"properties": {
"lastUpdatedDate": {
"description": "Date when application was last updated.Date in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"operation": {
"$ref": "#/definitions/Operation"
}
},
"required": [
"lastUpdatedDate",
"operation"
]
}
{
"type": "object",
"properties": {
"responseOperationCode": {
"description": "Response code of the operation settting in the mobile device application.",
"type": "integer",
"format": "int32",
"example": 200
},
"responseOperationDescription": {
"description": "Description response code of the operation settting in the mobile device application.",
"type": "string",
"example": "OK"
},
"operationType": {
"description": "Type of operations performed on setting in the mobile device application.",
"type": "string",
"example": "Enable NFC"
}
},
"required": [
"responseOperationCode",
"responseOperationDescription",
"operationType"
]
}
{
"properties": {
"type": {
"type": "string",
"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"
]
},
"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": "More Info can be used to pass any additional details",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}