Jump to

• Request
• Response

API to authorize the manually released uncollected amount

patch

/service/uncollectedamt/{id}/approve

This endpoint is used to authorize the manually released uncollected amount.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Key Id for releasing uncollected Amount for an Account

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created balance

Body ()

Root Schema : UncollectedResponseDtoWrapper

Type: object

Show Source

• data(optional): object UncollectedReleaseMasterDto
• messages(optional): object ResponseDtoWrapper

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDtoWrapper"
        },
        "data":{
            "$ref":"#/definitions/UncollectedReleaseMasterDto"
        }
    }
}

Nested Schema : UncollectedReleaseMasterDto

Type: object

Show Source

• authStatus(optional): string
• checkerDateStamp(optional): string
  Date and Time when some action on Virtual Account is authorized
• checkerId(optional): string
  Checker ID of Virtual Account
• keyId(optional): string
• makerDateStamp(optional): string
  Date and Time when Virtual Account is created or modified or closed or reopened
• makerId(optional): string
  Maker ID of Virtual Account
• referenceNo(optional): string
• sourceCode(optional): string
• uncollectedReleaseDetailDtoList(optional): array uncollectedReleaseDetailDtoList

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string"
        },
        "referenceNo":{
            "type":"string"
        },
        "sourceCode":{
            "type":"string"
        },
        "makerId":{
            "type":"string",
            "description":"Maker ID of Virtual Account"
        },
        "makerDateStamp":{
            "type":"string",
            "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID of Virtual Account"
        },
        "checkerDateStamp":{
            "type":"string",
            "description":"Date and Time when some action on Virtual Account is authorized"
        },
        "authStatus":{
            "type":"string"
        },
        "uncollectedReleaseDetailDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UncollectedReleaseDetailDto"
            }
        }
    }
}

Nested Schema : ResponseDtoWrapper

Type: object

Show Source

• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : uncollectedReleaseDetailDtoList

Type: array

Show Source

• Array of: object UncollectedReleaseDetailDto

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UncollectedReleaseDetailDto"
    }
}

Nested Schema : UncollectedReleaseDetailDto

Type: object

Show Source

• expectedReleaseDate(optional): string
• id(optional): string
• referenceNo(optional): string
• txnRefNo(optional): string
• uncollectedAmount(optional): number
• unCollMasterId(optional): string
• vaCcy(optional): string
• valueDate(optional): string
• virtualAccountNo(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "unCollMasterId":{
            "type":"string"
        },
        "referenceNo":{
            "type":"string"
        },
        "txnRefNo":{
            "type":"string"
        },
        "virtualAccountNo":{
            "type":"string"
        },
        "vaCcy":{
            "type":"string"
        },
        "valueDate":{
            "type":"string"
        },
        "uncollectedAmount":{
            "type":"number"
        },
        "expectedReleaseDate":{
            "type":"string"
        }
    }
}

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top