production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/products/branches/enrollment
post /v1/cards/products/branches/enrollment
card-product-branch-enrollment
LOB:Cards; Feature:Batch Request Debit and Credit Cards; Functionality:Create
This API depending on the classification, whether it is a debit or credit card, will trigger the funcionality of enroll new products.
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
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept
Required in header
string
Content-Types that are acceptable for the response
Accept-Language
Optional in header
string
List of acceptable human languages for response
{
"default": "es"
}ChannelId
Required in header
string
Channel where request originated
Content-Type
Required in header
string
Content-Types that are sent in the request
{
"default": "application\/json"
}countryCode
Required in header
string
Country code in 2 character ISO 3166 format
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
{
"default": "GCB"
}sid
Required in header
string
SessionId sent by Consumer
createCardProductRequest
Required in body
object
204
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | cannotDecryptData | 620-Cannot decrypt, please re-check the encrypted value |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | productNotAllowed | The card is not allowed to issue CVV2 and 2FA. |
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 |
| error | backendError | Failed during a call to backend service |
| error | timeoutError | Time to complete a transaction is over |
| 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/products/branches/enrollment
put /v1/cards/products/branches/enrollment
update-card-product-branch-enrollment
LOB:Cards; Feature:Batch Request Debit and Credit Cards; Functionality:Authorization
This API depending on the classification, whether it is a debit or credit card, will trigger the funcionality of update existing products.
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
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept
Required in header
string
Content-Types that are acceptable for the response
Accept-Language
Optional in header
string
List of acceptable human languages for response
{
"default": "es"
}ChannelId
Required in header
string
Channel where request originated
Content-Type
Required in header
string
Content-Types that are sent in the request
{
"default": "application\/json"
}countryCode
Required in header
string
Country code in 2 character ISO 3166 format
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
{
"default": "GCB"
}sid
Required in header
string
SessionId sent by Consumer
updateCardProductRequest
Required in body
object
204
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | cannotDecryptData | 620-Cannot decrypt, please re-check the encrypted value |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | productNotAllowed | The card is not allowed to issue CVV2 and 2FA. |
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 |
| error | backendError | Failed during a call to backend service |
| error | timeoutError | Time to complete a transaction is over |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/products/branches/enrollment
/v1/cards/products/branches/enrollment/delete
put /v1/cards/products/branches/enrollment/delete
delete-card-product-branch-enrollment
LOB:Cards; Feature: Batch Request Debit and Credit Cards; Functionality:Cancellation
This API depending on the classification, whether it is a debit or credit card, will trigger the funcionality of delete existing products.
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
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept
Required in header
string
Content-Types that are acceptable for the response
Accept-Language
Optional in header
string
List of acceptable human languages for response
{
"default": "es"
}ChannelId
Required in header
string
Channel where request originated
Content-Type
Required in header
string
Content-Types that are sent in the request
{
"default": "application\/json"
}countryCode
Required in header
string
Country code in 2 character ISO 3166 format
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
{
"default": "GCB"
}sid
Required in header
string
SessionId sent by Consumer
deleteCardProductRequest
Required in body
object
204
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | cannotDecryptData | 620-Cannot decrypt, please re-check the encrypted value |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | productNotAllowed | The card is not allowed to issue CVV2 and 2FA. |
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 |
| error | backendError | Failed during a call to backend service |
| error | timeoutError | Time to complete a transaction is over |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/products/branches/enrollment/delete
/v1/cards/products/branches/enrollment/retrieve
post /v1/cards/products/branches/enrollment/retrieve
retrieve-card-product-branch-enrollment
LOB:Cards; Feature:Batch Request Debit and Credit Cards; Functionality:retrieve
This API depending on the classification, whether it is a debit or credit card, will trigger the funcionality of retrieve information about product list.
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
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept
Required in header
string
Content-Types that are acceptable for the response
Accept-Language
Optional in header
string
List of acceptable human languages for response
{
"default": "es"
}ChannelId
Required in header
string
Channel where request originated
Content-Type
Required in header
string
Content-Types that are sent in the request
{
"default": "application\/json"
}countryCode
Required in header
string
Country code in 2 character ISO 3166 format
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
{
"default": "GCB"
}sid
Required in header
string
SessionId sent by Consumer
retrieveCardProductInfoRequest
Required in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | cannotDecryptData | 620-Cannot decrypt, please re-check the encrypted value |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | productNotAllowed | The card is not allowed to issue CVV2 and 2FA. |
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 |
| error | backendError | Failed during a call to backend service |
| error | timeoutError | Time to complete a transaction is over |
| 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/products/branches/enrollment/retrieve
Definitions
{
"type": "object",
"properties": {
"branchTypeCode": {
"description": "Code to define whether the product is created at the branch or sales unit level. For example: B: branch S: Sales",
"maxLength": 1,
"type": "string",
"example": "B"
},
"branchName": {
"description": "Name of the Branch or the Sales Unit",
"maxLength": 32,
"type": "string",
"example": "Sucursal Acapulco"
},
"cardTypeCode": {
"description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
"maxLength": 3,
"type": "string",
"example": "322"
},
"embossedProductCode": {
"description": "This field will send the Number of the Product of the card for example 994 that means 'Simplicity', 941 that means 'Teleton'",
"maxLength": 3,
"type": "string",
"example": "994"
},
"productId": {
"description": "Unique Identifier of the plastic card for example 607 - 'Simplicity', 620 - 'Citi Rewards'",
"maxLength": 3,
"type": "string",
"example": "607"
},
"stockProvidePercentage": {
"description": "Percentage in which a new supply of cards must be generated for the branch",
"type": "number",
"format": "double",
"example": 50.15
},
"initialStockCount": {
"description": "Number of cards in the initial request",
"type": "integer",
"format": "int32",
"example": 123456
},
"monthsSinceCardExpirationNumber": {
"description": "Number of months before the card expires and can be assigned to a customer",
"type": "integer",
"format": "int32",
"example": 12
}
},
"required": [
"branchTypeCode",
"branchName",
"cardTypeCode",
"embossedProductCode",
"productId",
"stockProvidePercentage",
"initialStockCount",
"monthsSinceCardExpirationNumber"
]
}
{
"type": "object",
"properties": {
"branchTypeCode": {
"description": "Code to define whether the product is created at the branch or sales unit level. For example: B: branch S: Sales",
"maxLength": 1,
"type": "string",
"example": "B"
},
"branchName": {
"description": "Name of the Branch or the Sales Unit",
"maxLength": 32,
"type": "string",
"example": "Sucursal Acapulco"
},
"cardTypeCode": {
"description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
"maxLength": 3,
"type": "string",
"example": "322"
},
"embossedProductCode": {
"description": "This field will send the Number of the Product of the card for example 994 that means 'Simplicity', 941 that means 'Teleton'",
"maxLength": 3,
"type": "string",
"example": "994"
},
"productId": {
"description": "Unique Identifier of the plastic card for example 607 - 'Simplicity', 620 - 'Citi Rewards'",
"maxLength": 3,
"type": "string",
"example": "607"
},
"stockProvidePercentage": {
"description": "Percentage in which a new supply of cards must be generated for the branch",
"type": "number",
"format": "double",
"example": 50.15
},
"initialStockCount": {
"description": "Number of cards in the initial request",
"type": "integer",
"format": "int32",
"example": 123456
},
"monthsSinceCardExpirationNumber": {
"description": "Number of months before the card expires and can be assigned to a customer",
"type": "integer",
"format": "int32",
"example": 12
}
},
"required": [
"branchTypeCode",
"branchName",
"cardTypeCode",
"embossedProductCode",
"productId",
"stockProvidePercentage",
"initialStockCount",
"monthsSinceCardExpirationNumber"
]
}
{
"type": "object",
"properties": {
"branchTypeCode": {
"description": "Code to define whether the product is created at the branch or sales unit level. For example: B: branch S: Sales",
"maxLength": 1,
"type": "string",
"example": "B"
},
"branchName": {
"description": "Name of the Branch or the Sales Unit",
"maxLength": 32,
"type": "string",
"example": "Sucursal Acapulco"
},
"cardTypeCode": {
"description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
"maxLength": 3,
"type": "string",
"example": "322"
},
"embossedProductCode": {
"description": "This field will send the Number of the Product of the card for example 994 that means 'Simplicity', 941 that means 'Teleton'",
"maxLength": 3,
"type": "string",
"example": "994"
},
"productId": {
"description": "Unique Identifier of the plastic card for example 607 - 'Simplicity', 620 - 'Citi Rewards'",
"maxLength": 3,
"type": "string",
"example": "607"
}
},
"required": [
"branchTypeCode",
"branchName",
"cardTypeCode",
"embossedProductCode",
"productId"
]
}
{
"type": "object",
"properties": {
"branchTypeCode": {
"description": "Code to define whether the product is created at the branch or sales unit level. For example: B: branch S: Sales",
"maxLength": 1,
"type": "string",
"example": "B"
},
"branchName": {
"description": "Name of the Branch or the Sales Unit",
"maxLength": 32,
"type": "string",
"example": "Sucursal Acapulco"
},
"pagination": {
"$ref": "#/definitions/Pagination"
}
},
"required": [
"branchTypeCode",
"branchName"
]
}
{
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/definitions/Products"
}
},
"pagination": {
"$ref": "#/definitions/Pagination"
}
}
}
{
"type": "object",
"properties": {
"cardTypeCode": {
"description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
"maxLength": 3,
"type": "string",
"example": "322"
},
"embossedProductCode": {
"description": "This field will send the Number of the Product of the card for example 994 that means 'Simplicity', 941 that means 'Teleton'",
"maxLength": 3,
"type": "string",
"example": "994"
},
"productId": {
"description": "Unique Identifier of the plastic card for example 607 - 'Simplicity', 620 - 'Citi Rewards'",
"maxLength": 3,
"type": "string",
"example": "607"
},
"stockProvidePercentage": {
"description": "Percentage in which a new supply of cards must be generated for the branch",
"type": "number",
"format": "double",
"example": 50.15
},
"initialStockCount": {
"description": "Number of cards in the initial request",
"type": "integer",
"format": "int32",
"example": 123456
},
"monthsSinceCardExpirationNumber": {
"description": "Number of months before the card expires and can be assigned to a customer",
"type": "integer",
"format": "int32",
"example": 12
}
}
}
{
"type": "object",
"properties": {
"nextBranchName": {
"description": "This field will have the next branch name for pagination and for better display.",
"maxLength": 32,
"type": "string",
"example": "Zara Galerias"
},
"nextCardTypeCode": {
"description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
"maxLength": 3,
"type": "string",
"example": "322"
},
"nextEmbossedProductCode": {
"description": "This field will send the Number of the Product of the card for example 994 that means 'Simplicity', 941 that means 'Teleton'",
"maxLength": 3,
"type": "string",
"example": "994"
},
"nextProductId": {
"description": "Unique Identifier of the plastic card for example 607 - 'Simplicity', 620 - 'Citi Rewards'",
"maxLength": 3,
"type": "string",
"example": "607"
}
}
}
{
"required": [
"code",
"details",
"location",
"moreInfo",
"timestamp",
"type"
],
"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": {
"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"
},
"timestamp": {
"type": "string",
"description": "Timestamp of the error"
}
}
}