digifi-swagger/schemas/ProvideLoanRequest.json

{
    "type": "object",
    "properties": {
        "$type": {
            "type": "string",
            "description": "Value is fixed to 'ProvideLoanRequest'",
            "example": "ProvideLoanRequest"
        },
        "requestId": {
            "type": "string",
            "description": "Unique identifier of request",
            "example": "202111170001371256908"
        },
        "transactionId": {
            "type": "string",
            "description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey",
            "example": "Tr201712RK9232P115"
        },
        "customerId": {
            "type": "string",
            "description": "Unique identifier of a customer",
            "example": "CN621868"
        },
        "accountId": {
            "type": "string",
            "description": "Specific identifier of a user's account",
            "example": "ACN8263457"
        },
        "msisdn": {
            "type": "string",
            "description": "User's mobile number in an international format",
            "example": "3451342"
        },
        "productId": {
            "type": "string",
            "description": "Identifier of a product chosen by user",
            "example": "101"
        },
        "lienAmount": {
            "type": "number",
            "format": "double",
            "description": "Amount of lien placed on user's account",
            "example": 400
        },
        "requestedAmount": {
            "type": "number",
            "format": "double",
            "description": "Amount of loan that requested by user",
            "example": 900
        },
        "collectionType": {
            "type": "integer",
            "description": "Type of collection that user is preferred. 0 – as soon as salary inflow occurs; 1- as soon as any new inflow occurs, 1 – collection after XX days.",
            "enum": [0, 1],
            "example": 1
        },
        "loanType": {
            "type": "integer",
            "description": "Type of loan. 0 – simple; 1 – refinance.",
            "enum": [0, 1],
            "example": 0
        },
        "channel": {
            "type": "string",
            "description": "Request channel: 'USSD' or 'MobileApp' or 'Web'",
            "enum": ["USSD", "MobileApp", "Web"],
            "example": "USSD"
        }
    },
    "required": [
        "$type",
        "transactionId",
        "customerId",
        "accountId",
        "productId",
        "requestedAmount",
        "collectionType",
        "loanType",
        "channel"
    ],
    "xml": {
        "name": "ProvideLoanRequest"
    }
}