Jump to

• Request
• Response

Retrieves the list of uncollected amount transactions

get

/service/uncollectedAmtTxns

This endpoint is used to retrieve the list of uncollected amount transactions.

Request

Supported Media Types

• application/json

Query Parameters

• endDate(optional): string
  End Date
• startDate(optional): string
  Start Date
• txnRefNo(optional): string
  Transaction Reference Number
• virtualAccountNo(optional): string
  Virtual Account Number

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 : UncollectedAmtServiceDtoCollection

Type: object

Show Source

• UncollectedAmtDtoList(optional): array UncollectedAmtDtoList

{
    "type":"object",
    "properties":{
        "UncollectedAmtDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UncollectedAmtServiceDto"
            }
        }
    }
}

Nested Schema : UncollectedAmtDtoList

Type: array

Show Source

• Array of: object UncollectedAmtServiceDto

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

Nested Schema : UncollectedAmtServiceDto

Type: object

Show Source

• actualReleaseDate(optional): string
• expectedReleaseDate(optional): string
• releaseType(optional): string
• sourceRefNo(optional): string
• txnRefNo(optional): string
• uncollectedAmount(optional): number
• vaCcy(optional): string
• valueDate(optional): string
• virtualAccount(optional): string

{
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string"
        },
        "expectedReleaseDate":{
            "type":"string"
        },
        "actualReleaseDate":{
            "type":"string"
        },
        "releaseType":{
            "type":"string"
        },
        "uncollectedAmount":{
            "type":"number"
        },
        "valueDate":{
            "type":"string"
        },
        "vaCcy":{
            "type":"string"
        },
        "virtualAccount":{
            "type":"string"
        },
        "sourceRefNo":{
            "type":"string"
        }
    }
}

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