Paths
/v1/cards/provisioning/organization
LOB: TS&CO Container(OD&T); Feature: Register a new organization or branch; Functionality: Register a new organization or branch for future card provisionig request
This API helps to register a new organization or branch for future card provisionig request.
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
LOB: TS&CO Container(OD&T); Feature: Modify the status of an organization or branch; Functionality: Modify the registered status with a new status for the indicated organization or branch.
This API helps to modify the registered status with a new status for the indicated organization or branch.
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/cards/provisioning/organizations/status
LOB: TS&CO Container(OD&T); Feature: Update the status of an organization or branch; Functionality: Update the status of an organization or branch.
This API helps to update the status of an organization or branch.
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/cards/provisioning/organizations/retrieve
LOB: TS&CO Container; Feature: Inquiry the information of an organization or branch; Functionality: Inquiry the information registered of the organization or branch.
This API helps to inquiry the information registered of the organization or branch.
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"properties": {
"productCode": {
"description": "Key of the product contracted by the organization Ex. 01-Bancanet Empresarial / TEF Nomina. 02-Digitem / TEF Nomina",
"type": "string",
"maxLength": 2,
"example": "02"
},
"serviceFeeIndicator": {
"description": "Indicator that specifies if the organization/branch accepts commissions for the provisioning service. Ex. 01-Yes. 02-No",
"type": "string",
"maxLength": 2,
"example": "01"
},
"organization": {
"$ref": "#/definitions/Organization"
}
},
"required": [
"productCode",
"serviceFeeIndicator",
"organization"
]
}
{
"type": "object",
"properties": {
"productCode": {
"description": "Key of the product contracted by the organization Ex. 01-Bancanet Empresarial / TEF Nomina. 02-Digitem / TEF Nomina",
"type": "string",
"maxLength": 2,
"example": "02"
},
"serviceFeeIndicator": {
"description": "Indicator that specifies if the organization/branch accepts commissions for the provisioning service. Ex. 01-Yes. 02-No",
"type": "string",
"maxLength": 2,
"example": "01"
},
"organization": {
"$ref": "#/definitions/Organization"
}
},
"required": [
"productCode",
"serviceFeeIndicator",
"organization"
]
}
{
"type": "object",
"properties": {
"organizationId": {
"description": "Identifier of the company or branch that previously was register for provisioning requests",
"type": "string",
"maxLength": 16,
"example": "0000028804220011"
}
},
"required": [
"organizationId"
]
}
{
"type": "object",
"properties": {
"organizationId": {
"description": "Identifier of the company that, as a client, hired the payroll card for its employees.",
"type": "string",
"maxLength": 16,
"example": "0000028804220011"
}
},
"required": [
"organizationId"
]
}
{
"type": "object",
"properties": {
"productCode": {
"description": "Key of the product contracted by the organization Ex. 01-Bancanet Empresarial / TEF Nomina. 02-Digitem / TEF Nomina",
"type": "string",
"maxLength": 2,
"example": "02"
},
"serviceFeeIndicator": {
"description": "Indicator that specifies if the organization/branch accepts commissions for the provisioning service. Ex. 01-Yes. 02-No",
"type": "string",
"maxLength": 2,
"example": "01"
},
"organizationData": {
"$ref": "#/definitions/OrganizationData"
}
},
"required": [
"productCode",
"serviceFeeIndicator",
"organizationData"
]
}
{
"type": "object",
"properties": {
"organizationFullName": {
"description": "Name of the company/branch that is registered or will be registered for plastic cards provisioning",
"type": "string",
"maxLength": 75,
"example": "Ford Motors Company de México, S.A. de C.V."
},
"organizationStatusCode": {
"description": "Organization status. Ex. 0-Active. 1-Inactive. 2-Baja.",
"type": "string",
"maxLength": 2,
"example": "1"
},
"organizationContact": {
"$ref": "#/definitions/OrganizationContact"
}
},
"required": [
"organizationFullName",
"organizationStatusCode",
"organizationContact"
]
}
{
"type": "object",
"properties": {
"organizationId": {
"description": "Identifier of the company that, as a client, hired the payroll card for its employees",
"type": "string",
"maxLength": 16,
"example": "0000028804220011"
},
"organizationFullName": {
"description": "Name of the company/branch that is registered or will be registered for plastic cards provisioning",
"type": "string",
"maxLength": 75,
"example": "Ford Motors Company de México, S.A. de C.V."
},
"organizationStatusCode": {
"description": "Organization status. Ex. 00-Activa. 01-Inactiva. 02-Baja.",
"type": "string",
"maxLength": 2,
"example": "01"
},
"organizationContact": {
"$ref": "#/definitions/OrganizationContact"
}
},
"required": [
"organizationId",
"organizationStatusCode",
"organizationFullName",
"organizationContact"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Organization(as a customer) identifier assigned to the organziation by the Bank",
"type": "string",
"maxLength": 12,
"example": "000204453307"
},
"legalRepresentative": {
"$ref": "#/definitions/LegalRepresentative"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"fullName": {
"description": "Name of the legal representative responsible for the Organization",
"type": "string",
"maxLength": 55,
"example": "Juan Perez Perez"
},
"emailAddress": {
"description": "Email Address of the legal representative responsible for the Organization",
"type": "string",
"maxLength": 75,
"example": "jperezperez@ford.com.mx"
},
"phoneNumber": {
"description": "Phone Number of the legal representative responsible for the Organization",
"type": "string",
"maxLength": 10,
"example": "5555688722"
},
"extensionNumber": {
"description": "Telephone extension number of the legal representative responsible for the Organization",
"type": "string",
"maxLength": 5,
"example": "12345"
},
"faxNumber": {
"description": "Fax number of the legal representative responsible for the Organization",
"type": "string",
"maxLength": 10,
"example": " 5555688904"
}
},
"required": [
"fullName",
"phoneNumber"
]
}
{
"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"
]
}