production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/servicing/action/retrieve
post /v1/cards/servicing/action/retrieve
card-servicing-action-data
To retrieve detail of all servicing actions for the cards of the customer
This API is used to retrieve detail of all servicing actions for the cards of the customer
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
Optional in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
operationId
Optional in query
integer
Id for the operation to be performed.
cardsActionStatusesRequest
Optional in body
object
200
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/cards/servicing/action/retrieve
Definitions
{
"type": "object",
"properties": {
"cardAccount": {
"type": "array",
"items": {
"$ref": "#/definitions/CardAccount"
}
}
}
}
{
"type": "object",
"properties": {
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
}
}
}
{
"type": "object",
"properties": {
"invalidAccounts": {
"type": "array",
"items": {
"$ref": "#/definitions/InvalidAccount"
}
},
"cardAccountDetail": {
"type": "array",
"items": {
"$ref": "#/definitions/CardAccountDetail"
}
}
}
}
{
"type": "object",
"properties": {
"validResponseFlag": {
"description": "validResponseFlag",
"type": "boolean",
"example": true
},
"invalidResponseMessage": {
"description": "invalidResponseMessage",
"type": "string",
"example": "the account doesn't exists"
},
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
},
"accountNumber": {
"description": "The account associated to the customer",
"type": "string",
"example": "000000000000149078"
},
"branchId": {
"description": "The branch id where the account was created",
"type": "string",
"example": "1234"
},
"accountType": {
"description": "Type of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"accountTypeDescription": {
"description": "Name of the type of the account",
"type": "string",
"example": "Cuenta maestra"
},
"currencyCode": {
"description": "The currency code identifier of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"currencyCodeDescription": {
"description": "Currency Code of the account",
"type": "string",
"example": "MXN"
},
"accountNickName": {
"description": "Nickname of the account",
"type": "string",
"example": "Mi cuenta favorita"
},
"productCode": {
"description": "Product code that identify the type of account",
"type": "integer",
"format": "int32",
"example": 66
},
"productInstrument": {
"description": "The product instrument code",
"type": "integer",
"format": "int32",
"example": 12
},
"accountAlias": {
"description": "CLABE of the account",
"type": "string",
"example": "123456789123"
},
"productName": {
"description": "The product name",
"type": "string",
"example": "Checking Account"
},
"displayAccountNumber": {
"description": "Tha last digits of the account or card",
"type": "string",
"example": "1234"
},
"deviceAccessData": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountMediaAccess"
}
}
},
"required": [
"accountId",
"accountNumber",
"displayAccountNumber",
"productCode",
"productInstrument",
"currencyCode",
"currencyCodeDescription",
"accountType",
"accountTypeDescription"
]
}
{
"type": "object",
"properties": {
"deviceAccessUniqueId": {
"description": "Unique ID used by front end to identify the account as a device access",
"type": "string",
"example": "23234"
},
"deviceAccessStatus": {
"description": "status of access Media",
"type": "integer",
"format": "int64",
"example": 0
},
"deviceAccessStatusDescription": {
"description": "description of access media status",
"type": "string",
"example": "ACTIVO HASTA SU VENCIMIENTO"
},
"deviceAccessType": {
"description": "type of device Access Media",
"type": "integer",
"format": "int32",
"example": 0
},
"deviceAccessTypeDescription": {
"description": "description of type of device Access Media",
"type": "string",
"example": "Chequera"
},
"deviceAccessNickName": {
"description": "Nickname of the account",
"type": "string",
"example": "Mi cuenta favorita"
},
"productName": {
"description": "The product name",
"type": "string",
"example": "Checking Account"
},
"displayDeviceAccessNumber": {
"description": "displayAccessMedia",
"type": "string",
"example": "123"
},
"deviceAccessPrefix": {
"description": "The device access prefix which is first four digits of account/card",
"type": "string",
"example": "7002"
},
"cardPlastic": {
"$ref": "#/definitions/CardPlastic"
}
},
"required": [
"deviceAccessUniqueId",
"deviceAccessStatus",
"deviceAccessStatusDescription",
"deviceAccessTypeDescription",
"deviceAccessType",
"displayDeviceAccessNumber",
"deviceAccessPrefix"
]
}
{
"type": "object",
"properties": {
"cardType": {
"description": "Type of the card",
"type": "string",
"example": "Credit"
},
"cardStatus": {
"description": "Status of the card",
"type": "string",
"example": "Active"
},
"creditLimitAmount": {
"description": "Credit limit amount on the card account",
"type": "number",
"format": "double",
"example": 1200.56
},
"cardLockedFlag": {
"description": "Flag to check whether card is locked or not",
"type": "boolean",
"example": false
},
"pinChangeRequiredFlag": {
"description": "Flag to specify whether pin change is required for this account",
"type": "boolean",
"example": false
}
},
"required": [
"cardType",
"cardStatus"
]
}
{
"type": "object",
"properties": {
"validResponseFlag": {
"description": "validResponseFlag",
"type": "boolean",
"example": true
},
"invalidResponseMessage": {
"description": "invalidResponseMessage",
"type": "string",
"example": "the account doesn't exists"
},
"account": {
"$ref": "#/definitions/Account"
}
}
}
{
"type": "object",
"properties": {
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
},
"accountNumber": {
"description": "The account associated to the customer",
"type": "string",
"example": "000000000000149078"
},
"branchId": {
"description": "The branch id where the account was created",
"type": "string",
"example": "1234"
},
"productCode": {
"description": "Product code that identify the type of account",
"type": "integer",
"format": "int32",
"example": 66
},
"productInstrument": {
"description": "The product instrument code",
"type": "integer",
"format": "int32",
"example": 12
},
"accountAlias": {
"description": "CLABE of the account",
"type": "string",
"example": "123456789123"
},
"accountType": {
"description": "",
"type": "integer",
"format": "int32",
"example": 1
},
"accountTypeDescription": {
"description": "Name of the type of the account",
"type": "string",
"example": "Cuenta maestra"
},
"productName": {
"description": "The product name",
"type": "string",
"example": "Checking Account"
},
"currencyCode": {
"description": "The currency code identifier of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"currencyCodeDescription": {
"description": "Currency Code of the account",
"type": "string",
"example": "MXN"
},
"deviceAccessData": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountMediaAccessDetail"
}
}
},
"required": [
"accountId",
"productCode",
"productInstrument",
"currencyCode",
"currencyCodeDescription",
"accountType",
"accountTypeDescription",
"productName"
]
}
{
"type": "object",
"properties": {
"deviceAccessId": {
"description": "access Media Id",
"type": "string",
"example": "123456789012"
},
"deviceAccessStatus": {
"description": "access Media status",
"type": "integer",
"format": "int32",
"example": 1
},
"deviceAccessStatusDescription": {
"description": "description of access media status",
"type": "string",
"example": "ACTIVO HASTA SU VENCIMIENTO"
},
"deviceAccessType": {
"description": "type of device Access Media",
"type": "integer",
"format": "int32",
"example": 1
},
"deviceAccessTypeDescription": {
"description": "description of type of device Access Media",
"type": "string",
"example": "Chequera"
},
"deviceAccessPrefix": {
"description": "The device access prefix which is first four digits of account/card",
"type": "string",
"example": "7002"
},
"deviceAccessUniqueId": {
"description": "Unique ID used by front end to identify the account as a device access",
"type": "string",
"example": "23234"
},
"productName": {
"description": "The product name",
"type": "string",
"example": "Checking Account"
}
},
"required": [
"deviceAccessId",
"deviceAccessStatus",
"deviceAccessType",
"deviceAccessPrefix",
"deviceAccessStatusDescription",
"deviceAccessTypeDescription",
"deviceAccessUniqueId"
]
}
{
"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"
]
}