SERV-SOR-D-TesofeAcMgt

SERV-SOR-D-TesofeAcMgt 1.0.0

0
No votes yet

This microservice is used to manage users' TESOFE accounts.

production
development
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2

Paths

/v1/servicing/accounts/tesofe/retrieve

/v1/servicing/accounts/tesofe/structure/retrieve

Definitions 

{
    "type": "object",
    "properties": {
        "customerId": {
            "description": "Unique Identifier of the customer.",
            "type": "string",
            "example": "123456789012"
        },
        "dataCenterLocation": {
            "description": "Data center location",
            "type": "string",
            "example": "10"
        }
    },
    "required": [
        "customerId",
        "dataCenterLocation"
    ]
}
              
{
    "type": "object",
    "properties": {
        "customerName": {
            "description": "Name of the customer.",
            "type": "string",
            "example": "Roberto Vilchis"
        },
        "account": {
            "$ref": "#/definitions/Account"
        }
    },
    "required": [
        "customerName"
    ]
}
              
{
    "type": "object",
    "properties": {
        "accountNumber": {
            "description": "Account number",
            "type": "string",
            "example": "82749287364928300000"
        },
        "branchId": {
            "description": "Branch to which the account belongs",
            "type": "string",
            "example": "5894"
        },
        "accountUsageType": {
            "description": "This field refers to the account property that indicates about the tesofe customer. The values it can take are 60: Count normal control, 61: Concentrator Control Account, 62: Normal Subaccount, 63: Concentrator Subaccount",
            "type": "string",
            "example": "60"
        },
        "lastUpdatedDate": {
            "description": "Data when the last update was made to the account.",
            "type": "string",
            "format": "date",
            "example": "2020-09-22"
        },
        "product": {
            "$ref": "#/definitions/Product"
        },
        "accountMediaAccess": {
            "$ref": "#/definitions/AccountMediaAccessData"
        }
    },
    "required": [
        "accountNumber",
        "branchId",
        "accountUsageType",
        "lastUpdatedDate",
        "product"
    ]
}
              
{
    "type": "object",
    "properties": {
        "productCode": {
            "description": "Unique identifier of the product",
            "type": "string",
            "example": "1234"
        },
        "productInstrument": {
            "description": "Product instrument code of the account",
            "type": "string",
            "example": "12"
        }
    },
    "required": [
        "productCode",
        "productInstrument"
    ]
}
              
{
    "type": "object",
    "properties": {
        "deviceAccessPrefix": {
            "description": "The device access prefix which is first four digits of account",
            "type": "string",
            "example": "7008",
            "maxLength": 4,
            "pattern": "^[0-9]*$"
        },
        "deviceAccessId": {
            "description": "Unique device access media ID",
            "type": "string",
            "example": "000000278445",
            "maxLength": 12,
            "pattern": "^[0-9]*$"
        }
    },
    "required": [
        "deviceAccessPrefix",
        "deviceAccessId"
    ]
}
              
{
    "type": "object",
    "properties": {
        "queryType": {
            "description": "Indicates the type of query that will be made to the legacy system. Example Values: I- Initial consultation, S- Subsequent consultation, N- Final consultation, T- Entire account structure, D- Specific Sub-account Query, X- Specific Query of Account Control",
            "type": "string",
            "enum": [
                "I",
                "S",
                "N",
                "T",
                "D",
                "X"
            ],
            "example": "I"
        },
        "checkingAccountId": {
            "description": "Unique identifier of the customer�s checking account",
            "type": "string",
            "example": "7008000000278445",
            "minLength": 16,
            "maxLength": 16,
            "pattern": "^[0-9]*$"
        },
        "lastRelatedCheckingAccountId": {
            "description": "The reference for the last related checking account that is used to get the next account set, when there are more information to retrieve",
            "type": "string",
            "example": "7008000000278445",
            "minLength": 16,
            "maxLength": 16,
            "pattern": "^[0-9]*$"
        }
    },
    "required": [
        "checkingAccountId"
    ]
}
              
{
    "type": "object",
    "properties": {
        "moreInformationFlag": {
            "description": "More Information Flag",
            "type": "boolean",
            "example": true
        },
        "checkingAccount": {
            "$ref": "#/definitions/CheckingAccount"
        }
    },
    "required": [
        "moreInformationFlag"
    ]
}
              
{
    "type": "object",
    "properties": {
        "accountId": {
            "description": "Unique identifier of the customer�s checking account",
            "type": "string",
            "example": "7008000000278445",
            "minLength": 16,
            "maxLength": 16,
            "pattern": "^[0-9]*$"
        },
        "customerId": {
            "description": "Unique Identifier of the customer owner of the checking account",
            "type": "string",
            "example": "123456789012"
        },
        "relatedCheckingAccounts": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/CheckingAccountDetail"
            }
        }
    },
    "required": [
        "accountId",
        "customerId"
    ]
}
              
{
    "type": "object",
    "properties": {
        "accountId": {
            "description": "Unique identifier of the customer�s checking account",
            "type": "string",
            "example": "7008000000278445",
            "minLength": 16,
            "maxLength": 16,
            "pattern": "^[0-9]*$"
        },
        "accountHierarchyLevel": {
            "description": "Level of the checking account in the tesofe account�s hierarchy",
            "type": "string",
            "example": "1",
            "maxLength": 2
        },
        "accountStatusCode": {
            "description": "Status of the checking account",
            "type": "string",
            "example": "21",
            "maxLength": 2
        },
        "currencyCode": {
            "description": "Currency Code",
            "type": "string",
            "example": "01",
            "maxLength": 2
        },
        "accountUsageType": {
            "description": "This field refers to the account property that indicates about the tesofe customer. The values it can take are 60: Count normal control, 61: Concentrator Control Account, 62: Normal Subaccount, 63: Concentrator Subaccount",
            "type": "string",
            "example": "60",
            "maxLength": 2
        },
        "customerId": {
            "description": "Unique Identifier of the customer.",
            "type": "string",
            "example": "123456789012"
        },
        "customerName": {
            "description": "Name of the customer who is the owner of the sub account",
            "type": "string",
            "example": "MALVEX S.A de C.V"
        }
    },
    "required": [
        "accountId",
        "accountHierarchyLevel",
        "accountStatusCode",
        "currencyCode",
        "accountUsageType",
        "customerId",
        "customerName"
    ]
}
              
{
    "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": "More Info can be used to pass any additional details",
            "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"
    ]
}