Jump to

• Request
• Response

Get all valid obvam-statement-services

post

/service/accStatement

This endpoints is used to generate account statements for an entity.

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request body contains data required to create a new obvam-statement-services.

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

Type: object

Collection of entries.

Show Source

• data(optional): object AdviceResponse
  Advice Response
• messages(optional): object ResponseDto

{
    "description":"Collection of entries.",
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/AdviceResponse"
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : AdviceResponse

Type: object

Advice Response

Show Source

• documentInbase64(optional): string
  Document in Base64
• documentNature(optional): string
  Document Content Type for the document
• documentReferenceId(optional): string
  Document Id for the document

{
    "description":"Advice Response",
    "type":"object",
    "properties":{
        "documentReferenceId":{
            "description":"Document Id for the document",
            "type":"string"
        },
        "documentInbase64":{
            "description":"Document in Base64",
            "type":"string"
        },
        "documentNature":{
            "description":"Document Content Type for the document",
            "type":"string"
        }
    }
}

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

Bad request error, the server is unable to process the request

401 Response

Unauthorized request error, invalid credentials

403 Response

Request denied, no permission to access the request

405 Response

Request denied, invalid input

500 Response

Internal server error

Back to Top