Previous Next JavaScript must be enabled to correctly display this content

## Charges Inquiry

get

/service/chargeInquiry

This endpoint is used for the charges inquiry for the account.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- applicationCode: string
- chargeCode(optional): string
- collectionStatus(optional): string
- fromDate: string
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- realCustomerNo: string
- toDate: string

Header Parameters

- sourceCode: string
  Source from which request is initiated

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Returns the charge maintenance actions based on given id.
Body ()
Root Schema : ChargeInquiryDetailCollection
Type: `object`
Collection of Charge Details.
Show Source

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

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object ChargeInquiryServiceDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

Nested Schema : ChargeInquiryServiceDTO
Type: `object`
Match All
Show Source

- object ChargeInquiryServiceDTO-allOf[0]

    {
        "type":"object",
        "allOf":[
            {
                "type":"object",
                "properties":{
                    "chargeFromDate":{
                        "type":"string",
                        "description":"charge from Date."
                    },
                    "chargeToDate":{
                        "type":"string",
                        "description":"charge to Date"
                    },
                    "chargeCode":{
                        "type":"string",
                        "description":"Charge Code."
                    },
                    "chargeDescription":{
                        "type":"string",
                        "description":"charge Description"
                    },
                    "additionalInfo":{
                        "type":"string",
                        "description":"Additional Information on charge."
                    },
                    "chargeCCY":{
                        "type":"string",
                        "description":"Charge Currency."
                    },
                    "chargeAmount":{
                        "type":"number",
                        "description":"Charge Amount."
                    },
                    "chargeAccountCCY":{
                        "type":"string",
                        "description":"Charge Account Currency"
                    },
                    "chargeAccount":{
                        "type":"string",
                        "description":"Charge Account."
                    },
                    "exchangeRate":{
                        "type":"number",
                        "description":"Exchange Rate"
                    },
                    "postedAmount":{
                        "type":"number",
                        "description":"Posted Amount."
                    },
                    "collectionDate":{
                        "type":"string",
                        "description":"collection Date"
                    },
                    "collectionStatus":{
                        "type":"string",
                        "description":"Collection Status."
                    },
                    "errorDesc":{
                        "type":"string",
                        "description":"Error Description in case charge error."
                    }
                }
            }
        ]
    }

Nested Schema : ChargeInquiryServiceDTO-allOf[0]
Type: `object`
Show Source

- additionalInfo(optional): string
  Additional Information on charge.
- chargeAccount(optional): string
  Charge Account.
- chargeAccountCCY(optional): string
  Charge Account Currency
- chargeAmount(optional): number
  Charge Amount.
- chargeCCY(optional): string
  Charge Currency.
- chargeCode(optional): string
  Charge Code.
- chargeDescription(optional): string
  charge Description
- chargeFromDate(optional): string
  charge from Date.
- chargeToDate(optional): string
  charge to Date
- collectionDate(optional): string
  collection Date
- collectionStatus(optional): string
  Collection Status.
- errorDesc(optional): string
  Error Description in case charge error.
- exchangeRate(optional): number
  Exchange Rate
- postedAmount(optional): number
  Posted Amount.

    {
        "type":"object",
        "properties":{
            "chargeFromDate":{
                "type":"string",
                "description":"charge from Date."
            },
            "chargeToDate":{
                "type":"string",
                "description":"charge to Date"
            },
            "chargeCode":{
                "type":"string",
                "description":"Charge Code."
            },
            "chargeDescription":{
                "type":"string",
                "description":"charge Description"
            },
            "additionalInfo":{
                "type":"string",
                "description":"Additional Information on charge."
            },
            "chargeCCY":{
                "type":"string",
                "description":"Charge Currency."
            },
            "chargeAmount":{
                "type":"number",
                "description":"Charge Amount."
            },
            "chargeAccountCCY":{
                "type":"string",
                "description":"Charge Account Currency"
            },
            "chargeAccount":{
                "type":"string",
                "description":"Charge Account."
            },
            "exchangeRate":{
                "type":"number",
                "description":"Exchange Rate"
            },
            "postedAmount":{
                "type":"number",
                "description":"Posted Amount."
            },
            "collectionDate":{
                "type":"string",
                "description":"collection Date"
            },
            "collectionStatus":{
                "type":"string",
                "description":"Collection Status."
            },
            "errorDesc":{
                "type":"string",
                "description":"Error Description in case charge error."
            }
        }
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 500 Response

Internal error
Back to Top