Jump to

• Request
• Response

Create the charges transaction details

post

/service/v1/postChargesTxnData

This endpoint is used to create the charges transaction details.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  App Id
• branchCode(required): string
  Branch Code
• userId(required): string
  User Id

Body ()

Request body with charges transaction details to be persisted

Root Schema : ObChargesTxnDTOCollection

Type: object

Collection of ObChargesTxnDTO.

Show Source

• obChargesTxnDTOList: array obChargesTxnDTOList

{
    "description":"Collection of ObChargesTxnDTO.",
    "type":"object",
    "properties":{
        "obChargesTxnDTOList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObChargesTxnDTO"
            }
        }
    }
}

Nested Schema : obChargesTxnDTOList

Type: array

Show Source

• Array of: object ObChargesTxnDTO

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

Nested Schema : ObChargesTxnDTO

Type: object

Show Source

• allowOverride: string
• allowPrcModify: string
• allowWaive: string
• applicationCode: string
• autoWaive: string
• branchCode: string
• calcEndDate: string(date)
• calcErrorCode: string
• calcFreq: string
• calcRefPeriod: string
• calcStartDate: string(date)
• calcType: string
• calcUnits: number
• chargeAmount: number
• chargeCategory: string
• chargeCode: string
• chargeCodeDesc: string
• chargeCriteria: string
• chargeCriteriaValue: number
• chargeGroup: string
• chargeType: string
• chgCalcDate: string(date)
• chgCriteriaCcy: string
• chgCriteriaCount: string
• chgSharing: string
• chgSharingPct: number
• collectionFreq: string
• collectionRefPeriod: string
• collectionType: string
• collectionUnits: number
• creditAccNumber: string
• debitAccNumber: string
• eventCode: string
• exchangeRate: number
• firstChgCalcDate: string(date)
• firstChgCollDate: string(date)
• instrumentType: string
• nextChgCalcDate: string(date)
• nextChgCollDate: string(date)
• parentChargeCode: string
• partyId: string
• partyName: string
• partyToCharge: string
• postingErrorCode: string
• priceMethodDesc: string
• priceTemplateId: string
• referenceEndDate: string
• referenceEndDateValue: string(date)
• referenceStartDate: string
• referenceStartDateValue: string(date)
• txnCcy: string
• txnRefNo: string

{
    "type":"object",
    "properties":{
        "allowOverride":{
            "type":"string"
        },
        "allowPrcModify":{
            "type":"string"
        },
        "allowWaive":{
            "type":"string"
        },
        "applicationCode":{
            "type":"string"
        },
        "autoWaive":{
            "type":"string"
        },
        "branchCode":{
            "type":"string"
        },
        "calcErrorCode":{
            "type":"string"
        },
        "calcFreq":{
            "type":"string"
        },
        "calcRefPeriod":{
            "type":"string"
        },
        "calcType":{
            "type":"string"
        },
        "calcUnits":{
            "type":"number"
        },
        "chargeAmount":{
            "type":"number"
        },
        "chargeCategory":{
            "type":"string"
        },
        "chargeCode":{
            "type":"string"
        },
        "chargeCodeDesc":{
            "type":"string"
        },
        "chargeGroup":{
            "type":"string"
        },
        "chargeType":{
            "type":"string"
        },
        "chgCalcDate":{
            "type":"string",
            "format":"date"
        },
        "txnCcy":{
            "type":"string"
        },
        "chargeCriteria":{
            "type":"string"
        },
        "chargeCriteriaValue":{
            "type":"number"
        },
        "chgCriteriaCcy":{
            "type":"string"
        },
        "chgCriteriaCount":{
            "type":"string"
        },
        "priceMethodDesc":{
            "type":"string"
        },
        "priceTemplateId":{
            "type":"string"
        },
        "chgSharing":{
            "type":"string"
        },
        "instrumentType":{
            "type":"string"
        },
        "collectionType":{
            "type":"string"
        },
        "collectionFreq":{
            "type":"string"
        },
        "collectionRefPeriod":{
            "type":"string"
        },
        "collectionUnits":{
            "type":"number"
        },
        "parentChargeCode":{
            "type":"string"
        },
        "partyId":{
            "type":"string"
        },
        "partyToCharge":{
            "type":"string"
        },
        "postingErrorCode":{
            "type":"string"
        },
        "referenceEndDate":{
            "type":"string"
        },
        "referenceStartDate":{
            "type":"string"
        },
        "referenceEndDateValue":{
            "type":"string",
            "format":"date"
        },
        "referenceStartDateValue":{
            "type":"string",
            "format":"date"
        },
        "txnRefNo":{
            "type":"string"
        },
        "partyName":{
            "type":"string"
        },
        "eventCode":{
            "type":"string"
        },
        "exchangeRate":{
            "type":"number"
        },
        "firstChgCalcDate":{
            "type":"string",
            "format":"date"
        },
        "nextChgCalcDate":{
            "type":"string",
            "format":"date"
        },
        "firstChgCollDate":{
            "type":"string",
            "format":"date"
        },
        "nextChgCollDate":{
            "type":"string",
            "format":"date"
        },
        "debitAccNumber":{
            "type":"string"
        },
        "creditAccNumber":{
            "type":"string"
        },
        "chgSharingPct":{
            "type":"number"
        },
        "calcStartDate":{
            "type":"string",
            "format":"date"
        },
        "calcEndDate":{
            "type":"string",
            "format":"date"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top