Jump to

• Request
• Response

Generate MT950 statement

post

/service/statement/mt950

This endpoint is used to generate MT950 statement for the given virtual account / entity.

Request

Supported Media Types

• application/json

Body ()

Request Body that contains data required for generating statement

Root Schema : StatementInDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object StatementInDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "virtualEntity":{
                    "type":"string",
                    "description":"Virtual entity for which the account statement has to be generated."
                },
                "virtualAccountNumber":{
                    "type":"string",
                    "description":"Virtual account number for which the account statement has to be generated. Please give ALL for consolidated report"
                },
                "fromDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date from when the transactions have to be fetched"
                },
                "toDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date till when the transactions have to be fetched"
                }
            },
            "required":[
                "virtualEntity",
                "fromDate",
                "toDate"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : StatementInDTO-allOf[1]

Type: object

Show Source

• fromDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Date from when the transactions have to be fetched
• toDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Date till when the transactions have to be fetched
• virtualAccountNumber(optional): string
  Virtual account number for which the account statement has to be generated. Please give ALL for consolidated report
• virtualEntity: string
  Virtual entity for which the account statement has to be generated.

{
    "type":"object",
    "properties":{
        "virtualEntity":{
            "type":"string",
            "description":"Virtual entity for which the account statement has to be generated."
        },
        "virtualAccountNumber":{
            "type":"string",
            "description":"Virtual account number for which the account statement has to be generated. Please give ALL for consolidated report"
        },
        "fromDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date from when the transactions have to be fetched"
        },
        "toDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date till when the transactions have to be fetched"
        }
    },
    "required":[
        "virtualEntity",
        "fromDate",
        "toDate"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : MessageOutDTOCollection

Type: object

Collection of SWIFT / CAMT messages.

Show Source

• data(optional): array data
• messages(optional): object ResponseDto

{
    "description":"Collection of SWIFT / CAMT messages.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MessageOutDTO"
            }
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object MessageOutDTO
  SWIFT / CAMT message

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

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

Type: object

SWIFT / CAMT message

Show Source

• branch(optional): string
• branchDate(optional): string
• id(optional): string
• makerDtStamp(optional): string(date)
• makerId(optional): string
• message(optional): string
• msgType(optional): string
• parentReferenceNo(optional): string
• referenceNo(optional): string
• virtualAccountNo(optional): string
• virtualEntityId(optional): string
  Virtual Entity id for accounts

{
    "description":"SWIFT / CAMT message",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "branch":{
            "type":"string"
        },
        "branchDate":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "msgType":{
            "type":"string"
        },
        "parentReferenceNo":{
            "type":"string"
        },
        "referenceNo":{
            "type":"string"
        },
        "virtualAccountNo":{
            "type":"string"
        },
        "makerId":{
            "type":"string"
        },
        "makerDtStamp":{
            "type":"string",
            "format":"date"
        },
        "virtualEntityId":{
            "description":"Virtual Entity id for accounts",
            "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