Jump to

• Request
• Response

Get all valid obvam-statement-services

get

/service/obvamStatementServices

This endpoints is used to list transactions for a virtual account for a given period.

Request

Supported Media Types

• application/json

Query Parameters

• accountType(optional): string
• authStat(optional): string
• drCr(optional): string
• fromDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• includeHierarchy(optional): string
  Pattern: [Y,N]

  Default Value: N
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• processingRefNo(optional): string
• sourceCode(optional): string
• toDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• transactionCcy(optional): string
• transactionFrom(optional): string
• transactionStatus(optional): string
• trnCode(optional): string
• trnDate(optional): string
• valueDate(optional): string
• virtualAccount: string

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : EntriesServiceDTOCollection

Type: object

Collection of entries.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of entries.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EntriesServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object EntriesServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : EntriesServiceDTO

Type: object

Match All

Show Source

• object EntriesServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "processingRefNo":{
                    "type":"string",
                    "description":""
                },
                "serialNo":{
                    "type":"number",
                    "description":""
                },
                "transactionStatus":{
                    "type":"string",
                    "description":""
                },
                "trnCode":{
                    "type":"string",
                    "description":""
                },
                "runningBalance":{
                    "type":"number",
                    "description":""
                },
                "drCr":{
                    "type":"string",
                    "description":""
                },
                "virtualAccount":{
                    "type":"string",
                    "description":""
                },
                "accountCcy":{
                    "type":"string",
                    "description":""
                },
                "accountCcyAmount":{
                    "type":"number",
                    "description":""
                },
                "transactionCcy":{
                    "type":"string",
                    "description":""
                },
                "transactionAmount":{
                    "type":"number",
                    "description":""
                },
                "trnDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":""
                },
                "valueDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":""
                },
                "addlText":{
                    "type":"string",
                    "description":""
                },
                "exchRate":{
                    "type":"number",
                    "description":""
                },
                "reconciliationRefNo":{
                    "type":"string",
                    "description":""
                },
                "sourceCode":{
                    "type":"string",
                    "description":""
                },
                "sourceRefNo":{
                    "type":"string",
                    "description":""
                },
                "showInStmt":{
                    "type":"string",
                    "description":""
                },
                "stmtDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":""
                },
                "accountType":{
                    "type":"string",
                    "description":""
                },
                "transactionFrom":{
                    "type":"string",
                    "description":""
                },
                "realAccountNo":{
                    "type":"string",
                    "description":"Real account number"
                },
                "realAccountBrn":{
                    "type":"string",
                    "description":"Branch code of Real account number"
                },
                "realAccCcy":{
                    "type":"string",
                    "description":"Currency of Real account number"
                },
                "excRateTxccyRaccy":{
                    "type":"number",
                    "description":"Exchange rate between Transaction currency and real account currency"
                },
                "amtInRealAccCcy":{
                    "type":"number",
                    "description":"Transaction amount in real account currency"
                },
                "realAccClass":{
                    "type":"string",
                    "description":"Account class of real account number"
                },
                "authStat":{
                    "type":"string",
                    "description":"Auth Stat"
                }
            }
        }
    ]
}

Nested Schema : EntriesServiceDTO-allOf[0]

Type: object

Show Source

• accountCcy(optional): string
• accountCcyAmount(optional): number
• accountType(optional): string
• addlText(optional): string
• amtInRealAccCcy(optional): number
  Transaction amount in real account currency
• authStat(optional): string
  Auth Stat
• drCr(optional): string
• exchRate(optional): number
• excRateTxccyRaccy(optional): number
  Exchange rate between Transaction currency and real account currency
• processingRefNo(optional): string
• realAccCcy(optional): string
  Currency of Real account number
• realAccClass(optional): string
  Account class of real account number
• realAccountBrn(optional): string
  Branch code of Real account number
• realAccountNo(optional): string
  Real account number
• reconciliationRefNo(optional): string
• runningBalance(optional): number
• serialNo(optional): number
• showInStmt(optional): string
• sourceCode(optional): string
• sourceRefNo(optional): string
• stmtDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• transactionAmount(optional): number
• transactionCcy(optional): string
• transactionFrom(optional): string
• transactionStatus(optional): string
• trnCode(optional): string
• trnDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• valueDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• virtualAccount(optional): string

{
    "type":"object",
    "properties":{
        "processingRefNo":{
            "type":"string",
            "description":""
        },
        "serialNo":{
            "type":"number",
            "description":""
        },
        "transactionStatus":{
            "type":"string",
            "description":""
        },
        "trnCode":{
            "type":"string",
            "description":""
        },
        "runningBalance":{
            "type":"number",
            "description":""
        },
        "drCr":{
            "type":"string",
            "description":""
        },
        "virtualAccount":{
            "type":"string",
            "description":""
        },
        "accountCcy":{
            "type":"string",
            "description":""
        },
        "accountCcyAmount":{
            "type":"number",
            "description":""
        },
        "transactionCcy":{
            "type":"string",
            "description":""
        },
        "transactionAmount":{
            "type":"number",
            "description":""
        },
        "trnDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":""
        },
        "valueDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":""
        },
        "addlText":{
            "type":"string",
            "description":""
        },
        "exchRate":{
            "type":"number",
            "description":""
        },
        "reconciliationRefNo":{
            "type":"string",
            "description":""
        },
        "sourceCode":{
            "type":"string",
            "description":""
        },
        "sourceRefNo":{
            "type":"string",
            "description":""
        },
        "showInStmt":{
            "type":"string",
            "description":""
        },
        "stmtDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":""
        },
        "accountType":{
            "type":"string",
            "description":""
        },
        "transactionFrom":{
            "type":"string",
            "description":""
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real account number"
        },
        "realAccountBrn":{
            "type":"string",
            "description":"Branch code of Real account number"
        },
        "realAccCcy":{
            "type":"string",
            "description":"Currency of Real account number"
        },
        "excRateTxccyRaccy":{
            "type":"number",
            "description":"Exchange rate between Transaction currency and real account currency"
        },
        "amtInRealAccCcy":{
            "type":"number",
            "description":"Transaction amount in real account currency"
        },
        "realAccClass":{
            "type":"string",
            "description":"Account class of real account number"
        },
        "authStat":{
            "type":"string",
            "description":"Auth Stat"
        }
    }
}

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