Rest API for Oracle Banking Cash Management

Calculates the charges

post

/service/v1/charges

This endpoint is used to calculates the charges based on given parameters.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

Application Id
branchCode(required): string

Branch Code
userId(required): string

User Id

Request Body For Charge Calculation

Root Schema : ChargeCalculationRequestDto

Type: object

Show Source

applicationCode: string
txnDetails: array txnDetails

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string"
        },
        "txnDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionDetailsRequestDto"
            }
        }
    }
}

Nested Schema : txnDetails

Type: array

Show Source

Array of: object TransactionDetailsRequestDto

Transaction Details RequestDto

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

Nested Schema : TransactionDetailsRequestDto

Type: object

Transaction Details RequestDto

Show Source

priceMethods: array priceMethods

Details of each charge to be calculated
txnAttributes: array txnAttributes
txnRefNo: string

Txn Ref No

{
    "description":"Transaction Details RequestDto",
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Txn Ref No"
        },
        "priceMethods":{
            "description":"Details of each charge to be calculated",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChargeCalculationDetails"
            }
        },
        "txnAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionAttribute"
            }
        }
    }
}

Nested Schema : priceMethods

Type: array

Details of each charge to be calculated

Show Source

Array of: object ChargeCalculationDetails

Charge Calculation Details

{
    "description":"Details of each charge to be calculated",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChargeCalculationDetails"
    }
}

Nested Schema : txnAttributes

Type: array

Show Source

Array of: object TransactionAttribute

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

Nested Schema : ChargeCalculationDetails

Type: object

Charge Calculation Details

Show Source

chargeCategory: string

Charge Category
chargeCode: string

Charge Code
chargeCodeDesc: string

Charge Code Description
chargeCriteria: string

Amount/Count on which charge needs to be calculated. e.g.FINANCE_AMOUNT, INVOICE_COUNT
chargeCriteriaValue: number

Amount/Count Value on which charge needs to be calculated
chargeGroup: string

Charge Group
chargeSharing: string

Flag to indicate if charge sharing is available
chargeSharingPct: number

Percentage of charge which will be charged to the given party
chargeType: string

Charge Type
chgCalcFreq: string

Charge Calculation Frequency
chgCalcRefPeriod: string

Charge Calculation Reference Period
chgCalcType: string

Charge Calculation Type
chgCalcUnit: number

Charge Calculation Frequency Unit
chgCollFreq: string

Charge Collection Frequency
chgCollRefPeriod: number

Charge Collection Reference Period
chgCollType: string

Charge Collection Type
chgCollUnit: number

Charge Collection Frequency Unit
exchangeRate: number

Exchange Rate
externalPricing: string

External Pricing Flag
externalPricingApplicable: string

External Pricing Applicable
externalPricingConsumerService: string

External Pricing Consumer Service Name
externalPricingIdDescription: string

External Pricing Identifier Description/Price Component Code Description
externalPricingIdentifier: string

External Pricing Identifier/Price Component Code
externalPricingSystem: string

External Pricing System
externalPricingSystemName: string

External Pricing System Name
isChargeCalculated: string

Is Charge Calculated
parentChargeCode: string

Parent Charge Code
partyId: string

Party Id which needs to be charged
partyToCharge: string

Party which needs to be charged
priceRuleId: string

Price Rule Id
refPeriodEndDate: string

Reference Period End Date Value
refPeriodStartDate: string

Reference Period Start Date Value
tenor: number

Period for which charge will be calculated
txnCcy: string

Transaction currency. It should be sent when chargeInTxnCcy is Y

{
    "description":"Charge Calculation Details",
    "type":"object",
    "properties":{
        "partyId":{
            "description":"Party Id which needs to be charged",
            "type":"string"
        },
        "chargeCode":{
            "description":"Charge Code",
            "type":"string"
        },
        "chargeCodeDesc":{
            "description":"Charge Code Description",
            "type":"string"
        },
        "parentChargeCode":{
            "description":"Parent Charge Code",
            "type":"string"
        },
        "chargeGroup":{
            "description":"Charge Group",
            "type":"string"
        },
        "chargeCategory":{
            "description":"Charge Category",
            "type":"string"
        },
        "chargeType":{
            "description":"Charge Type",
            "type":"string"
        },
        "chargeSharing":{
            "description":"Flag to indicate if charge sharing is available",
            "type":"string"
        },
        "partyToCharge":{
            "description":"Party which needs to be charged",
            "type":"string"
        },
        "chargeSharingPct":{
            "description":"Percentage of charge which will be charged to the given party",
            "type":"number"
        },
        "chargeCriteria":{
            "description":"Amount/Count on which charge needs to be calculated. e.g.FINANCE_AMOUNT, INVOICE_COUNT",
            "type":"string"
        },
        "chargeCriteriaValue":{
            "description":"Amount/Count Value on which charge needs to be calculated",
            "type":"number"
        },
        "tenor":{
            "description":"Period for which charge will be calculated",
            "type":"number"
        },
        "txnCcy":{
            "description":"Transaction currency. It should be sent when chargeInTxnCcy is Y",
            "type":"string"
        },
        "exchangeRate":{
            "description":"Exchange Rate",
            "type":"number"
        },
        "externalPricingApplicable":{
            "type":"string",
            "description":"External Pricing Applicable"
        },
        "externalPricingSystem":{
            "type":"string",
            "description":"External Pricing System"
        },
        "isChargeCalculated":{
            "type":"string",
            "description":"Is Charge Calculated"
        },
        "priceRuleId":{
            "type":"string",
            "description":"Price Rule Id"
        },
        "externalPricing":{
            "type":"string",
            "description":"External Pricing Flag"
        },
        "externalPricingConsumerService":{
            "type":"string",
            "description":"External Pricing Consumer Service Name"
        },
        "externalPricingIdentifier":{
            "type":"string",
            "description":"External Pricing Identifier/Price Component Code"
        },
        "externalPricingIdDescription":{
            "type":"string",
            "description":"External Pricing Identifier Description/Price Component Code Description"
        },
        "externalPricingSystemName":{
            "type":"string",
            "description":"External Pricing System Name"
        },
        "refPeriodStartDate":{
            "type":"string",
            "description":"Reference Period Start Date Value"
        },
        "refPeriodEndDate":{
            "type":"string",
            "description":"Reference Period End Date Value"
        },
        "chgCalcFreq":{
            "type":"string",
            "description":"Charge Calculation Frequency"
        },
        "chgCalcRefPeriod":{
            "type":"string",
            "description":"Charge Calculation Reference Period"
        },
        "chgCalcUnit":{
            "type":"number",
            "description":"Charge Calculation Frequency Unit"
        },
        "chgCollFreq":{
            "type":"string",
            "description":"Charge Collection Frequency"
        },
        "chgCollRefPeriod":{
            "type":"number",
            "description":"Charge Collection Reference Period"
        },
        "chgCollUnit":{
            "type":"number",
            "description":"Charge Collection Frequency Unit"
        },
        "chgCollType":{
            "type":"string",
            "description":"Charge Collection Type"
        },
        "chgCalcType":{
            "type":"string",
            "description":"Charge Calculation Type"
        }
    }
}

Nested Schema : TransactionAttribute

Type: object

Show Source

attrName: string
attrValue: string

{
    "type":"object",
    "properties":{
        "attrName":{
            "type":"string"
        },
        "attrValue":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Calculated charges

Root Schema : ChargesResponseDto

Type: object

Charges Response Dto

Show Source

applicationCode: string

Application Code
txnDetails: array txnDetails

{
    "description":"Charges Response Dto",
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"Application Code"
        },
        "txnDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionDetailsResponseDto"
            }
        }
    }
}

Nested Schema : txnDetails

Type: array

Show Source

Array of: object TransactionDetailsResponseDto

Transaction Details ResponseDto

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

Nested Schema : TransactionDetailsResponseDto

Type: object

Transaction Details ResponseDto

Show Source

chargeDetails: array chargeDetails

Collection of calculated charges
txnRefNo: string

Txn Ref No

{
    "description":"Transaction Details ResponseDto",
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Txn Ref No"
        },
        "chargeDetails":{
            "description":"Collection of calculated charges",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChargesDetails"
            }
        }
    }
}

Nested Schema : chargeDetails

Type: array

Collection of calculated charges

Show Source

Array of: object ChargesDetails

Charges Details

{
    "description":"Collection of calculated charges",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChargesDetails"
    }
}

Nested Schema : ChargesDetails

Type: object

Charges Details

Show Source

charge: number

Charge
chargeCcy: string

Charge Ccy
chargeCode: string

Charge Code
chgCalcFreq: string

Charge Calculation Frequency
chgCalcRefPeriod: string

Charge Calculation Reference Period
chgCalcUnit: number

Charge Calculation Frequency Unit
chgCollFreq: string

Charge Collection Frequency
chgCollRefPeriod: number

Charge Collection Reference Period
chgCollUnit: number

Charge Collection Frequency Unit
exchangeRate: number

Exchange Rate
partyId: string

Party Id
partyToCharge: string

Party to Charge
priceMethod: string

Price Method
refPeriodEndDate: string

Reference Period End Date Value
refPeriodStartDate: string

Reference Period Start Date Value
scheduleDetails: array scheduleDetails

Charge Schedule Details Collection
txnRefNo: string

Transaction Ref No

{
    "description":"Charges Details",
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Ref No"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "chargeCode":{
            "type":"string",
            "description":"Charge Code"
        },
        "partyToCharge":{
            "type":"string",
            "description":"Party to Charge"
        },
        "priceMethod":{
            "type":"string",
            "description":"Price Method"
        },
        "charge":{
            "type":"number",
            "description":"Charge"
        },
        "chargeCcy":{
            "type":"string",
            "description":"Charge Ccy"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "refPeriodStartDate":{
            "type":"string",
            "description":"Reference Period Start Date Value"
        },
        "refPeriodEndDate":{
            "type":"string",
            "description":"Reference Period End Date Value"
        },
        "chgCalcFreq":{
            "type":"string",
            "description":"Charge Calculation Frequency"
        },
        "chgCalcRefPeriod":{
            "type":"string",
            "description":"Charge Calculation Reference Period"
        },
        "chgCalcUnit":{
            "type":"number",
            "description":"Charge Calculation Frequency Unit"
        },
        "chgCollFreq":{
            "type":"string",
            "description":"Charge Collection Frequency"
        },
        "chgCollRefPeriod":{
            "type":"number",
            "description":"Charge Collection Reference Period"
        },
        "chgCollUnit":{
            "type":"number",
            "description":"Charge Collection Frequency Unit"
        },
        "scheduleDetails":{
            "type":"array",
            "description":"Charge Schedule Details Collection",
            "items":{
                "$ref":"#/definitions/ChargeScheduleDetails"
            }
        }
    }
}

Nested Schema : scheduleDetails

Type: array

Charge Schedule Details Collection

Show Source

Array of: object ChargeScheduleDetails

{
    "type":"array",
    "description":"Charge Schedule Details Collection",
    "items":{
        "$ref":"#/definitions/ChargeScheduleDetails"
    }
}

Nested Schema : ChargeScheduleDetails

Type: object

Show Source

calculationTenor: number

Calculation Tenor
chargeAmt: number

Charge Amount
chargeCalcDate: string

Charge Calculation Date
chargeCalcEndDate: string

Tenor End Date
chargeCalcStartDate: string

Tenor Start Date
chargeCalcStatus: string

Charge Collection Status
chargeCollDate: string

Charge Collection Date
chargeCollStatus: string

Charge Collection Status
chgCcy: string

Charge Currency
chgCollectionAmt: number

Original Charge Amount
nextChargeCalcDate: string

Next Charge Calculation Date
nextChargeCollDate: string

Next Charge Collection Date
oldChgAmt: number

Original Charge Amount

{
    "type":"object",
    "properties":{
        "chargeCalcDate":{
            "type":"string",
            "description":"Charge Calculation Date"
        },
        "chargeCalcStartDate":{
            "type":"string",
            "description":"Tenor Start Date"
        },
        "chargeCalcEndDate":{
            "type":"string",
            "description":"Tenor End Date"
        },
        "calculationTenor":{
            "type":"number",
            "description":"Calculation Tenor"
        },
        "chargeCollDate":{
            "type":"string",
            "description":"Charge Collection Date"
        },
        "chargeAmt":{
            "type":"number",
            "description":"Charge Amount"
        },
        "chgCcy":{
            "type":"string",
            "description":"Charge Currency"
        },
        "chargeCalcStatus":{
            "type":"string",
            "description":"Charge Collection Status"
        },
        "chargeCollStatus":{
            "type":"string",
            "description":"Charge Collection Status"
        },
        "oldChgAmt":{
            "type":"number",
            "description":"Original Charge Amount"
        },
        "nextChargeCollDate":{
            "type":"string",
            "description":"Next Charge Collection Date"
        },
        "nextChargeCalcDate":{
            "type":"string",
            "description":"Next Charge Calculation Date"
        },
        "chgCollectionAmt":{
            "type":"number",
            "description":"Original Charge Amount"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error