production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/provisioning-requests
post /v1/cards/provisioning-requests
create-card-provisioning-requests
LOB: OD&T; Feature: Card Plastic Provisioning Request; Functionality: Generate
This API is used to register a new provisioning request of card plastics for a branch or enterprise
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
createCardProvisioningRequest
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/provisioning-requests
put /v1/cards/provisioning-requests
update-card-provisioning-requests
LOB: OD&T; Feature: Plastic Card Provisioning Request; Functionality: Modify
This api is used to modify information or cancel the card plastic provisioning request
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
updateCardProvisioningRequest
Required 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
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/provisioning-requests
/v1/cards/provisioning-requests/retrieve
post /v1/cards/provisioning-requests/retrieve
retrieve-card-provisioning-requests
LOB: OD&T; Feature: Card Plastic Provisioning Request; Functionality: Retrieve
This API is used to retrieve the daily card plastic provisioning requests
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
retrieveCardProvisioningRequest
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/provisioning-requests/retrieve
/v1/cards/provisioning-requests/status
put /v1/cards/provisioning-requests/status
update-provisioning-requests-status
LOB: OD&T; Feature: Card Plastic Provisioning Request Status; Functionality: Modify
This API is used to update the card plastic provisioning request consigments status to mark them as authorized
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
updateProvisioningStatusRequest
Required 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
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/provisioning-requests/status
Definitions
{
"type": "object",
"properties": {
"cardProvisioning": {
"type": "array",
"minItems": 1,
"maxItems": 18,
"items": {
"$ref": "#/definitions/CardProvisioningData"
}
}
}
}
{
"type": "object",
"properties": {
"provisioningReferenceNumber": {
"description": "Reference number generated by TS&CO container to identify the provisioning request",
"type": "string",
"maxLength": 6,
"example": "705862"
}
},
"required": [
"provisioningReferenceNumber"
]
}
{
"type": "object",
"properties": {
"requestTypeCode": {
"description": "Type of request to filter (Automatic or Special)",
"type": "string",
"maxLength": 1,
"example": "1"
},
"productCode": {
"description": "Product line related with the type of card: excecutive profile payroll, Debit in branch, Profile debit in branch, Priority Debit in branch",
"type": "string",
"maxLength": 2,
"example": "02"
},
"bankIdentificationNumber": {
"description": "Card number Bin related to the provisioning of the requested plastic cards",
"type": "string",
"maxLength": 6,
"example": "881052"
},
"sirh": {
"description": "sirh of the branch where was required the provisioning",
"type": "string",
"maxLength": 4,
"example": "1970"
},
"organizationId": {
"description": "Identifier of the enterprise that required the provisioning",
"type": "string",
"maxLength": 16,
"example": "0000000000000045"
},
"requestStatusCode": {
"description": "Status for the requests to inquiry, can be 00-All status, 01-Pendients, 02-Authorized, 03-Canceled",
"type": "string",
"maxLength": 2,
"example": "03"
},
"provisioningReferenceNumber": {
"description": "Reference number generated by TS&CO container to identify the provisioning request",
"type": "string",
"maxLength": 6,
"example": "705862"
},
"productSerialNumber": {
"description": "Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning",
"type": "string",
"maxLength": 4,
"example": "0001"
}
}
}
{
"type": "object",
"properties": {
"cardProvisioning": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/definitions/CardProvisioning"
}
},
"moreInformationIndicator": {
"description": "Indicator of end of registers to receive from S054.",
"type": "string",
"example": "S",
"maxLength": 1
}
},
"required": [
"cardProvisioning",
"moreInformationIndicator"
]
}
{
"type": "object",
"properties": {
"cardProvisioning": {
"type": "array",
"minItems": 1,
"maxItems": 63,
"items": {
"$ref": "#/definitions/CardProvisioningInformation"
}
}
}
}
{
"type": "object",
"properties": {
"cardProvisioning": {
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"$ref": "#/definitions/CardProvisioningDetail"
}
}
}
}
{
"type": "object",
"properties": {
"provisioningReferenceNumber": {
"description": "Reference number generated by TS&CO container to identify the provisioning request",
"type": "string",
"maxLength": 6,
"example": "705862"
},
"productSerialNumber": {
"description": "Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning",
"type": "string",
"maxLength": 4,
"example": "0001"
},
"sirh": {
"description": "sirh of the branch where was required the provisioning",
"type": "string",
"maxLength": 4,
"example": "1970"
},
"organizationId": {
"description": "Identifier of the enterprise that required the provisioning",
"type": "string",
"maxLength": 16,
"example": "0000000000000045"
},
"organizationBranchId": {
"description": "Identifier of the branch that belongs to an organization where pre-registration request will be managed",
"type": "string",
"maxLength": 16,
"example": "0000000000004967"
},
"lastUpdatedDate": {
"description": "Last Date that indicates when the provisioning request was updated",
"type": "string",
"format": "date",
"maxLength": 10,
"example": "2021-10-20"
},
"bankIdentificationNumber": {
"description": "Card number Bin related to the provisioning of the requested plastic cards",
"type": "string",
"maxLength": 6,
"example": "881052"
},
"organizationStructureCode": {
"description": "This is an attribute that helps to indentify if the client 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"
},
"cardUsageCode": {
"description": "It helps to identify what the card provisioning request is destined for: sell, change or corporative",
"type": "string",
"example": "01",
"maxLength": 2
},
"cardRequestedCount": {
"description": "Amount of plastic cards(by product) requested",
"type": "integer",
"format": "int32",
"example": 20,
"minimum": 1,
"maximum": 9999
},
"payrollId": {
"description": "Payroll of the executive who made the provisioning request",
"type": "string",
"maxLength": 12,
"example": "000090752205"
}
},
"required": [
"productSerialNumber",
"lastUpdatedDate",
"bankIdentificationNumber",
"cardRequestedCount",
"payrollId"
]
}
{
"type": "object",
"properties": {
"requestDate": {
"description": "Date that indicates when the provisioning request was created in format aaaa-mm-dd",
"type": "string",
"format": "date",
"maxLength": 10,
"example": "2021-10-20"
},
"organizationStructureCode": {
"description": "This is an attribute that helps to indentify if the client is a member of some civil asociation or a non-profit group, Ex 0000-None",
"type": "string",
"maxLength": 4,
"example": "0000"
},
"cardUsageCode": {
"description": "It helps to identify what the card provisioning request is destined for: sell, change or corporative",
"type": "string",
"example": "01",
"maxLength": 2
},
"payrollId": {
"description": "Payroll of the executive who made the provisioning request",
"type": "string",
"example": "000090752205",
"maxLength": 12
},
"cardRequestedCount": {
"description": "Amount of plastic cards(by product) requested",
"type": "integer",
"format": "int32",
"example": 20,
"minimum": 1,
"maximum": 9999
},
"cardPlasticId": {
"description": "Type or design of the plastic card required for the provisioning",
"type": "string",
"example": "01",
"maxLength": 2
},
"organizationBranchId": {
"description": "Identifier of the branch that belongs to an organization where pre-registration request will be managed",
"type": "string",
"maxLength": 16,
"example": "0000000000004967"
},
"requestTypeCode": {
"description": "Type of request to filter (Automatic or Special)",
"type": "string",
"example": "A",
"maxLength": 1
},
"bankIdentificationNumber": {
"description": "Card number Bin related to the provisioning of the requested plastic cards",
"type": "string",
"example": "881052",
"maxLength": 6
},
"sirh": {
"description": "sirh of the branch where was required the provisioning",
"type": "string",
"example": "1970",
"maxLength": 4
},
"organizationId": {
"description": "Identifier of the enterprise that required the provisioning",
"type": "string",
"example": "0000000000000045",
"maxLength": 16
},
"requestStatusCode": {
"description": "Status for the requests to inquiry, can be 00-All status, 01-Pendients, 02-Authorized, 03-Canceled",
"type": "string",
"example": "03",
"maxLength": 2
},
"provisioningReferenceNumber": {
"description": "Reference number generated by TS&CO container to identify the provisioning request",
"type": "string",
"example": "705862",
"maxLength": 6
},
"productSerialNumber": {
"description": "Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning",
"type": "string",
"example": "0001",
"maxLength": 4
}
},
"required": [
"requestTypeCode",
"provisioningReferenceNumber",
"productSerialNumber",
"bankIdentificationNumber",
"cardRequestedCount",
"requestStatusCode",
"payrollId",
"requestDate"
]
}
{
"type": "object",
"properties": {
"provisioningReferenceNumber": {
"description": "Reference number generated by TS&CO container to identify the provisioning request",
"type": "string",
"example": "705862",
"maxLength": 6
},
"productSerialNumber": {
"description": "Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning",
"type": "string",
"example": "0024",
"maxLength": 4
},
"sirh": {
"description": "sirh of the branch where was required the provisioning",
"type": "string",
"example": "1970",
"maxLength": 4
},
"organizationId": {
"description": "Identifier of the enterprise that required the provisioning",
"type": "string",
"example": "0000028804220011",
"maxLength": 16
},
"organizationBranchId": {
"description": "Identifier of the branch that belongs to an organization where pre-registration request will be managed",
"type": "string",
"maxLength": 16,
"example": "0000000000004967"
},
"lastUpdatedDate": {
"description": "Last Date that indicates when the provisioning request was updated",
"type": "string",
"format": "date",
"example": "2017-07-21",
"maxLength": 10
},
"bankIdentificationNumber": {
"description": "Card number Bin related to the provisioning of the requested plastic cards",
"type": "string",
"example": "520694",
"maxLength": 6
},
"organizationStructureCode": {
"description": "This is an attribute that helps to indentify if the client is a member of some civil asociation or a non-profit group, Ex 0000-None",
"type": "string",
"example": "0000",
"maxLength": 4
},
"cardPlasticId": {
"description": "Type or design of the plastic card required for the provisioning",
"type": "string",
"example": "01",
"maxLength": 2
},
"cardUsageCode": {
"description": "It helps to identify what the card provisioning request is destined for: sell, change or corporative",
"type": "string",
"example": "01",
"maxLength": 2
},
"cardRequestedCount": {
"description": "Amount of plastic cards(by product) requested",
"type": "integer",
"format": "int32",
"example": 15,
"minimum": 1,
"maximum": 9999
},
"approverId": {
"description": "Identifier of the approver who authorized the provisioning request",
"type": "string",
"example": "000090752205",
"maxLength": 12
},
"requestStatusCode": {
"description": "Status for the requests to inquiry, can be 00-All status, 01-Pendients, 02-Authorized, 03-Canceled",
"type": "string",
"example": "03",
"maxLength": 2
},
"cancelReason": {
"description": "Free text with the wording of the justification that the user captures when he cancels a request.",
"type": "string",
"example": "Not applicable for this particular work unit.",
"maxLength": 60
}
},
"required": [
"provisioningReferenceNumber",
"productSerialNumber",
"lastUpdatedDate",
"bankIdentificationNumber",
"cardRequestedCount",
"approverId",
"requestStatusCode"
]
}
{
"type": "object",
"properties": {
"requestTypeCode": {
"description": "Type of request to filter (Automatic or Special)",
"type": "string",
"example": "A",
"maxLength": 1
},
"provisioningReferenceNumber": {
"description": "Reference number generated by TS&CO container to identify the provisioning request",
"type": "string",
"example": "705862",
"maxLength": 6
},
"productSerialNumber": {
"description": "Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning",
"type": "string",
"example": "0001",
"maxLength": 4
},
"requestStatusCode": {
"description": "Status for the requests to inquiry, can be 00-All status, 01-Pendients, 02-Authorized, 03-Canceled",
"type": "string",
"example": "03",
"maxLength": 2
},
"approverId": {
"description": "Identifier of the approver who authorized the provisioning request",
"type": "string",
"example": "000090752205",
"maxLength": 12
}
},
"required": [
"requestTypeCode",
"provisioningReferenceNumber",
"productSerialNumber",
"requestStatusCode",
"approverId"
]
}
{
"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"
]
}