AddProvOrganizationBranchRequest

{
    "type": "object",
    "properties": {
        "organizationBranch": {
            "$ref": "#/definitions/OrganizationBranch"
        }
    },
    "required": [
        "organizationBranch"
    ]
}
              

UpdateProvOrganizationBranchRequest

{
    "type": "object",
    "properties": {
        "organizationBranch": {
            "$ref": "#/definitions/OrganizationBranch"
        }
    },
    "required": [
        "organizationBranch"
    ]
}
              

UpdateProvOrgBranchStatusRequest

{
    "type": "object",
    "properties": {
        "organizationBranch": {
            "$ref": "#/definitions/OrganizationBranchData"
        }
    },
    "required": [
        "organizationBranch"
    ]
}
              

RetrieveProvOrgBranchDetailRequest

{
    "type": "object",
    "properties": {
        "organizationBranch": {
            "$ref": "#/definitions/OrganizationBranchData"
        }
    },
    "required": [
        "organizationBranch"
    ]
}
              

RetrieveProvOrgBranchDetailResponse

{
    "type": "object",
    "properties": {
        "organizationBranchName": {
            "description": "Name of the branch that belongs to an organization where pre-registration request will be managed",
            "type": "string",
            "example": "DIVISION CENTRAL",
            "maxLength": 75
        },
        "requestTypeCode": {
            "description": "Type of account opening request required by the organization.",
            "type": "string",
            "example": "01",
            "maxLength": 2
        },
        "organizationBranchStatusCode": {
            "description": "Status of the UDT life cycles stages in the application.",
            "type": "string",
            "example": "00",
            "maxLength": 2
        },
        "sirh": {
            "description": "SIRH of the branch that promoted the contract obtained by this web service",
            "type": "string",
            "example": "001",
            "maxLength": 4
        },
        "organizationBranchAdministrators": {
            "type": "array",
            "minItems": 1,
            "maxItems": 2,
            "items": {
                "$ref": "#/definitions/Administrator"
            }
        },
        "agent": {
            "$ref": "#/definitions/Agent"
        },
        "address": {
            "$ref": "#/definitions/Address"
        }
    },
    "required": [
        "sirh",
        "organizationBranchName",
        "requestTypeCode",
        "organizationBranchStatusCode",
        "organizationBranchAdministrators",
        "agent",
        "address"
    ]
}
              

RetrieveProvOrgBranchesRequest

{
    "type": "object",
    "properties": {
        "organizationId": {
            "description": "Identifier of the company that , as a customer, contracted the payroll card for its employees. Note: The company acts as an a intermediary for interbank electronic funds transfer (TEF) service such as the payroll card.",
            "type": "string",
            "example": "987654321012",
            "maxLength": 16
        },
        "organizationBranchId": {
            "description": "Identifier of the branch that belongs to an organization where pre-registration request will be managed",
            "type": "string",
            "example": "000000000000468",
            "maxLength": 16
        }
    },
    "required": [
        "organizationId"
    ]
}
              

RetrieveProvOrgBranchesResponse

{
    "type": "object",
    "properties": {
        "moreInformationIndicator": {
            "description": "more information indicator",
            "type": "string",
            "example": "S",
            "maxLength": 1
        },
        "organizationBranches": {
            "type": "array",
            "minItems": 0,
            "maxItems": 100,
            "items": {
                "$ref": "#/definitions/OrganizationBranchInformation"
            }
        }
    },
    "required": [
        "moreInformationIndicator",
        "organizationBranches"
    ]
}
              

OrganizationBranch

{
    "type": "object",
    "properties": {
        "organizationId": {
            "description": "Identifier of the company that , as a customer, contracted the payroll card for its employees. Note: The company acts as an a intermediary for interbank electronic funds transfer (TEF) service such as the payroll card.",
            "type": "string",
            "example": "987654321012",
            "maxLength": 16
        },
        "organizationBranchId": {
            "description": "Identifier of the branch that belongs to an organization where pre-registration request will be managed",
            "type": "string",
            "example": "000000000000468",
            "maxLength": 16
        },
        "organizationBranchName": {
            "description": "Name of the branch that belongs to an organization where pre-registration request will be managed",
            "type": "string",
            "example": "DIVISION CENTRAL",
            "maxLength": 75
        },
        "organizationBranchStatusCode": {
            "description": "Status of the UDT life cycles stages in the application.",
            "type": "string",
            "example": "00",
            "maxLength": 2
        },
        "requestTypeCode": {
            "description": "Type of account opening request required by the organization.",
            "type": "string",
            "example": "01",
            "maxLength": 2
        },
        "sirh": {
            "description": "SIRH of the branch that promoted the contract obtained by this web service",
            "type": "string",
            "example": "1523",
            "maxLength": 4
        },
        "organizationBranchAdministrators": {
            "type": "array",
            "minItems": 0,
            "maxItems": 2,
            "items": {
                "$ref": "#/definitions/Administrator"
            }
        },
        "agent": {
            "$ref": "#/definitions/Agent"
        },
        "address": {
            "$ref": "#/definitions/Address"
        }
    },
    "required": [
        "organizationId",
        "organizationBranchId",
        "requestTypeCode",
        "organizationBranchStatusCode",
        "address",
        "organizationBranchName",
        "sirh"
    ]
}
              

OrganizationBranchInformation

{
    "type": "object",
    "properties": {
        "organizationBranchId": {
            "description": "Identifier of the branch that belongs to an organization where pre-registration request will be managed",
            "type": "string",
            "example": "0000000000010",
            "maxLength": 16
        },
        "sirh": {
            "description": "SIRH of the branch that promoted the contract obtained by this web service",
            "type": "string",
            "example": "0001",
            "maxLength": 4
        },
        "organizationBranchName": {
            "description": "Name of the branch that belongs to an organization where pre-registration request will be managed",
            "type": "string",
            "example": "walmart-polanco",
            "maxLength": 75
        },
        "administratorName": {
            "description": "Name of the administrator of the UDT. Obtained for this service",
            "type": "string",
            "example": "Pedro Perez Garcia",
            "maxLength": 55
        },
        "payrollId": {
            "description": "Payroll of the branch executive who promoted the contract obtained for this service",
            "type": "string",
            "example": "000003532150",
            "maxLength": 12
        }
    },
    "required": [
        "organizationBranchId",
        "sirh",
        "organizationBranchName",
        "administratorName",
        "payrollId"
    ]
}
              

OrganizationBranchData

{
    "type": "object",
    "properties": {
        "organizationId": {
            "description": "Identifier of the company that , as a customer, contracted the payroll card for its employees. Note: The company acts as an a intermediary for interbank electronic funds transfer (TEF) service such as the payroll card.",
            "type": "string",
            "example": "987654321012",
            "maxLength": 16
        },
        "organizationBranchId": {
            "description": "Identifier of the branch that belongs to an organization where pre-registration request will be managed",
            "type": "string",
            "example": "000000000000468",
            "maxLength": 16
        }
    },
    "required": [
        "organizationId",
        "organizationBranchId"
    ]
}
              

Administrator

{
    "type": "object",
    "properties": {
        "fullName": {
            "description": "Name of the administrator of the organization branch, Obtained for this service",
            "type": "string",
            "example": "JAVIER ROMERO PAZ",
            "maxLength": 55
        },
        "phoneNumber": {
            "description": "Phone number of the organization branch, Obtained for this service",
            "type": "string",
            "example": "55488596",
            "maxLength": 10
        },
        "extensionNumber": {
            "description": "Extension number of the organization branch, Obtained for this service",
            "type": "string",
            "example": "00017",
            "maxLength": 5
        },
        "faxNumber": {
            "description": "Fax number of thte organization branch, Obtained for this service",
            "type": "string",
            "example": "55455860",
            "maxLength": 10
        },
        "emailAddress": {
            "description": "E-mail address of the organization branch, Obtained for this service",
            "type": "string",
            "example": "jaropa@yahoo.com",
            "maxLength": 75
        }
    },
    "required": [
        "fullName",
        "phoneNumber"
    ]
}
              

Agent

{
    "type": "object",
    "properties": {
        "payrollId": {
            "description": "Payroll of the branch executive who promoted the contract obtained for this service",
            "type": "string",
            "example": "000003532150",
            "maxLength": 12
        },
        "fullName": {
            "description": "Name of the branch executive who promoted the contrac obtain though this web service",
            "type": "string",
            "example": "JAVIER ROMERO GOMEZ",
            "maxLength": 55
        },
        "phoneNumber": {
            "description": "Phone number of the branch executive who promoted the contrac obtain though this web service",
            "type": "string",
            "example": "55488596",
            "maxLength": 10
        },
        "extensionNumber": {
            "description": "Extension of the branch executive who promoted the contrac obtained for this service",
            "type": "string",
            "example": "00017",
            "maxLength": 5
        },
        "emailAddress": {
            "description": "Email address of the branch executive who promoted the contrac obtain though this web service",
            "type": "string",
            "example": "jaropa@yahoo.com",
            "maxLength": 75
        }
    },
    "required": [
        "payrollId",
        "fullName",
        "phoneNumber"
    ]
}
              

Address

{
    "type": "object",
    "properties": {
        "streetName": {
            "description": "Street and address number of the organization branch",
            "type": "string",
            "example": "Benjamín Franklin 1256",
            "maxLength": 35
        },
        "colonyName": {
            "description": "Neighborhood of domicile of the organization branch",
            "type": "string",
            "example": "Polanco",
            "maxLength": 25
        },
        "city": {
            "description": "City, Delegation or population of the State of the republic of the UDT addres",
            "type": "string",
            "example": "Ciudad de México, Delegación Cuauhtémoc",
            "maxLength": 25
        },
        "stateName": {
            "description": "State of the republic of the organization branch",
            "type": "string",
            "example": "Ciudad de México.",
            "maxLength": 25
        },
        "postalCode": {
            "description": "Postal code of the organization branch address",
            "type": "string",
            "example": "50000",
            "maxLength": 5
        }
    },
    "required": [
        "streetName",
        "colonyName",
        "city",
        "stateName",
        "postalCode"
    ]
}
              

ErrorResponse

{
    "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"
    ]
}