Jump to

• Request
• Response

Charges Inquiry

get

/service/chargeInquiry

This endpoint is used inquiry the charges for accounts.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

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

Header Parameters

• sourceCode(required): 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: array data
• paging: 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: 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."
                },
                "chargeAccountName":{
                    "type":"string",
                    "description":"Charge Account Name."
                },
                "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: string
  Additional Information on charge.
• chargeAccount: string
  Charge Account.
• chargeAccountCCY: string
  Charge Account Currency
• chargeAccountName: string
  Charge Account Name.
• chargeAmount: number
  Charge Amount.
• chargeCCY: string
  Charge Currency.
• chargeCode: string
  Charge Code.
• chargeDescription: string
  charge Description
• chargeFromDate: string
  charge from Date.
• chargeToDate: string
  charge to Date
• collectionDate: string
  collection Date
• collectionStatus: string
  Collection Status.
• errorDesc: string
  Error Description in case charge error.
• exchangeRate: number
  Exchange Rate
• postedAmount: 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."
        },
        "chargeAccountName":{
            "type":"string",
            "description":"Charge Account Name."
        },
        "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