Jump to

• Request
• Response

Adds a new record in virtual account sanction status

post

/service/vasanctionstatus

This endpoint is used to update the sanction status for a virtual account.

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request Body that contains data required for creating a new virtual account sanction status request

Root Schema : VASanctionStatusServiceDTO

Type: object

Show Source

• accountDescription(optional): string
  Account description
• approverRemarks(optional): string
  Approver remarks
• authStatus(optional): string
  Auth status
• checkerDateStamp(optional): string(date)
  Checker Date time stamp
• checkerId(optional): string
  Checker ID
• currSanctionStatus(optional): string
  Current Authorized Sanction status
• customerNo(optional): string
  customer number
• keyId(optional): string
  ID of Virtual Account Sanction Status
• makerDateStamp(optional): string(date)
  Maker Date time stamp
• makerId(optional): string
  Maker ID
• newSanctionStatus: string
  Sanction status which needs to be updated
• referenceNo(optional): string
  Reference number of Virtual Account Closure Request submission
• sourceReferenceNo(optional): string
  Source reference number of Virtual Account Closure Request submission
• virtualAccountNo: string
  Virtual account number for which sanction status needs to get updated

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string",
            "description":"ID of Virtual Account Sanction Status"
        },
        "referenceNo":{
            "type":"string",
            "description":"Reference number of Virtual Account Closure Request submission"
        },
        "sourceReferenceNo":{
            "type":"string",
            "description":"Source reference number of Virtual Account Closure Request submission"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual account number for which sanction status needs to get updated"
        },
        "accountDescription":{
            "type":"string",
            "description":"Account description"
        },
        "currSanctionStatus":{
            "type":"string",
            "description":"Current Authorized Sanction status"
        },
        "newSanctionStatus":{
            "type":"string",
            "description":"Sanction status which needs to be updated"
        },
        "customerNo":{
            "type":"string",
            "description":"customer number"
        },
        "approverRemarks":{
            "type":"string",
            "description":"Approver remarks"
        },
        "authStatus":{
            "type":"string",
            "description":"Auth status"
        },
        "makerId":{
            "type":"string",
            "description":"Maker ID"
        },
        "makerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Maker Date time stamp"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID"
        },
        "checkerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Checker Date time stamp"
        }
    },
    "required":[
        "virtualAccountNo",
        "newSanctionStatus"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of success or failure

Headers

• Location: string
  URL of newly created Virtual Account Sanction Status

Body ()

Root Schema : VASanctionStatusServiceResponseWrapperDTO

Type: object

Show Source

• data(optional): object VASanctionStatusServiceDTO
• messages(optional): object VASanctionStatusServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/VASanctionStatusServiceResponseDto"
        },
        "data":{
            "$ref":"#/definitions/VASanctionStatusServiceDTO"
        }
    }
}

Nested Schema : VASanctionStatusServiceDTO

Type: object

Show Source

• accountDescription(optional): string
  Account description
• approverRemarks(optional): string
  Approver remarks
• authStatus(optional): string
  Auth status
• checkerDateStamp(optional): string(date)
  Checker Date time stamp
• checkerId(optional): string
  Checker ID
• currSanctionStatus(optional): string
  Current Authorized Sanction status
• customerNo(optional): string
  customer number
• keyId(optional): string
  ID of Virtual Account Sanction Status
• makerDateStamp(optional): string(date)
  Maker Date time stamp
• makerId(optional): string
  Maker ID
• newSanctionStatus: string
  Sanction status which needs to be updated
• referenceNo(optional): string
  Reference number of Virtual Account Closure Request submission
• sourceReferenceNo(optional): string
  Source reference number of Virtual Account Closure Request submission
• virtualAccountNo: string
  Virtual account number for which sanction status needs to get updated

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string",
            "description":"ID of Virtual Account Sanction Status"
        },
        "referenceNo":{
            "type":"string",
            "description":"Reference number of Virtual Account Closure Request submission"
        },
        "sourceReferenceNo":{
            "type":"string",
            "description":"Source reference number of Virtual Account Closure Request submission"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual account number for which sanction status needs to get updated"
        },
        "accountDescription":{
            "type":"string",
            "description":"Account description"
        },
        "currSanctionStatus":{
            "type":"string",
            "description":"Current Authorized Sanction status"
        },
        "newSanctionStatus":{
            "type":"string",
            "description":"Sanction status which needs to be updated"
        },
        "customerNo":{
            "type":"string",
            "description":"customer number"
        },
        "approverRemarks":{
            "type":"string",
            "description":"Approver remarks"
        },
        "authStatus":{
            "type":"string",
            "description":"Auth status"
        },
        "makerId":{
            "type":"string",
            "description":"Maker ID"
        },
        "makerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Maker Date time stamp"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID"
        },
        "checkerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Checker Date time stamp"
        }
    },
    "required":[
        "virtualAccountNo",
        "newSanctionStatus"
    ]
}

Nested Schema : VASanctionStatusServiceResponseDto

Type: object

Show Source

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

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

Nested Schema : codes

Type: array

Show Source

• Array of: object VASanctionStatusServiceResponseCode

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

Nested Schema : VASanctionStatusServiceResponseCode

Type: object

Show Source

• 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"
        }
    }
}

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