Jump to

• Request
• Response

End Collection Status on Account

post

/api/1.0/callActionTransactional/endCollStatusByAccId

This endpoint is used to End Collection status on an account.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

Request Body that contains data required for ending collection status on an account.

Root Schema : endCollStatusDto

Type: object

Show Source

• accountId(optional): string
• endDate(optional): string

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string
  URL of newly created Call Action

Body ()

Root Schema : DmCollStatDelInsColl

Type: object

Collection of DmCollectionStatus.

Show Source

• closedCollStat(optional): array closedCollStat

{
    "description":"Collection of DmCollectionStatus.",
    "type":"object",
    "properties":{
        "closedCollStat":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmCollStatDelInsCollDTO"
            }
        }
    }
}

Nested Schema : closedCollStat

Type: array

Show Source

• Array of: object DmCollStatDelInsCollDTO

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

Nested Schema : DmCollStatDelInsCollDTO

Type: object

Show Source

• accountId(optional): string
• collectionStatusCode(optional): string
• startDTTM(optional): string

{
    "type":"object",
    "properties":{
        "accountId":{
            "description":"",
            "type":"string"
        },
        "collectionStatusCode":{
            "description":"",
            "type":"string"
        },
        "startDTTM":{
            "type":"string",
            "description":""
        }
    }
}

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