Jump to

• Request
• Response

Retrieve the existing collection status based on account ID

get

/api/1.0/callActionTransactional/getExistingCollectionStatus

This endpoint is used to retrieve the existing collection status based on an account ID.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountId: string
  The Account ID for which existing collection status to be fetched.

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• entityId(required): string
  The entity ID of host service.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Headers

• Location: string
  Returns the collection status based on account ID.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DmAccountCollectionStatusDTO
  DTO of account IDs collection status

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

Nested Schema : DmAccountCollectionStatusDTO

Type: object

DTO of account IDs collection status

Show Source

• accountID: string
• collectionStatus: string
• startDate: string

{
    "description":"DTO of account IDs collection status",
    "type":"object",
    "properties":{
        "accountID":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "collectionStatus":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top