production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/bins/indicators/retrieve
post /v1/cards/bins/indicators/retrieve
retrieve-bins-indicators
LOB: TS&CO Container(OD&T); Feature: Get a list of BINs Identifiers; Functionality: Obtains the list of possible BINs to generate/request a provisioning request, as well as, the characteristics to present/request per product according to the BIN
This api obtains the list of possible BINs to generate/request a provisioning request, as well as, the characteristics to present/request per product according to the BIN.
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
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
retrieveBinsIndicatorsRequest
Required 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/bins/indicators/retrieve
Definitions
{
"type": "object",
"properties": {
"bankIdentificationNumber": {
"description": "Card number Bin related to the provisioning of the requested plastic cards",
"type": "string",
"maxLength": 6,
"example": "881052"
},
"organizationStructureCode": {
"description": "This is a card attribute that indentifies if the user is a member of some civil asociation or a non-profit group, Ex 0000-None",
"type": "string",
"maxLength": 4,
"example": "0003"
},
"cardPlasticId": {
"description": "Type or design of the plastic card required for the provisioning",
"type": "string",
"maxLength": 2,
"example": "01"
}
},
"required": [
"bankIdentificationNumber",
"organizationStructureCode",
"cardPlasticId"
]
}
{
"type": "object",
"properties": {
"moreInformationIndicator": {
"description": "more information indicator",
"type": "string",
"minLength": 1,
"maxLength": 1,
"example": "S"
},
"binsIndicators": {
"type": "array",
"minItems": 0,
"maxItems": 200,
"items": {
"$ref": "#/definitions/BinIndicatorsInformation"
}
}
}
}
{
"type": "object",
"properties": {
"bankIdentificationNumber": {
"description": "Card number Bin related to the provisioning of the requested plastic cards",
"type": "string",
"maxLength": 6,
"example": "881052"
},
"organizationStructureCode": {
"description": "This is a card attribute that indentifies if the user is a member of some civil asociation or a non-profit group, Ex 0000-None",
"type": "string",
"maxLength": 4,
"example": "0000"
},
"cardPlasticId": {
"description": "Type or design of the plastic card required for the provisioning",
"type": "string",
"maxLength": 2,
"example": "01"
},
"organizationFlag": {
"description": "Indicator that the BIN Product has the Organization attribute, this indicates that said attribute will be shown on the screen and will be active",
"type": "boolean",
"example": true
},
"organizationBranchFlag": {
"description": "Indicator that the BIN Product has the organization branch attribute, this indicates that said attribute will be shown on the screen and will be active",
"type": "boolean",
"example": false
},
"organizationStructureCodeFlag": {
"description": "Indicator that the BIN Product has the Organization Structure Code attribute, this indicates that said attribute will be shown on the screen and will be active",
"type": "boolean",
"example": true
},
"cardPlasticIdFlag": {
"description": "Indicator that the BIN Product has the Card Plastic Id attribute, this indicates that said attribute will be shown on the screen and will be active",
"type": "boolean",
"example": false
},
"cardUsageCodeFlag": {
"description": "Indicator that the BIN Product has the Card Usage Code attribute, this indicates that said attribute will be shown on the screen and will be active",
"type": "boolean",
"example": true
},
"cardType": {
"description": "The first six digits of the credit card number encode the card type/issuer. Sometimes the relationship between card numbers and card type can be simplified into a rule like Visa credit card numbers start with 4Master card numbers start with 5American Express card numbers start with 3It is also referred as Card_Association_Network.",
"type": "string",
"maxLength": 20,
"example": "Visa Gold"
},
"embossedProductName": {
"description": "Product name embossed on the card.For Eg: Citi Premier Miles (Citi Card Name)",
"type": "string",
"maxLength": 12,
"example": "Soriana"
}
},
"required": [
"bankIdentificationNumber",
"organizationStructureCode",
"cardPlasticId",
"organizationFlag",
"organizationBranchFlag",
"organizationStructureCodeFlag",
"cardPlasticIdFlag",
"cardUsageCodeFlag"
]
}
{
"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": "URI to human readable documentation of the error",
"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"
]
}