Jump to

• Request
• Response

Update External charge posting status

post

/service/updateExternalChargePosting

This endpoint is used to update charge posting status for external postings.

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

request body contains details of external posting and posting status

Root Schema : PostingInputDTO

Type: object

Match All

Show Source

• object PostingInputDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "applicationCode":{
                    "type":"string",
                    "description":"application code"
                },
                "chgRefno":{
                    "type":"string",
                    "description":"charge reference number"
                },
                "collectionDate":{
                    "type":"string",
                    "description":"collection Date"
                },
                "chgPostingStatus":{
                    "type":"string",
                    "description":"Collection Status."
                },
                "chgPostingError":{
                    "type":"string",
                    "description":"Error Description in case charge error."
                },
                "ddaSystem":{
                    "type":"string",
                    "description":"dda system"
                },
                "accountccy":{
                    "type":"string",
                    "description":"Account currency"
                },
                "chargeCcy":{
                    "type":"string",
                    "description":"charge currency"
                },
                "chgPostedAmount":{
                    "type":"number",
                    "description":"chg Amnt In Account curreny that got posted"
                },
                "exchgRate":{
                    "type":"number",
                    "description":"exchange rate"
                }
            },
            "required":[
                "chgRefno",
                "collectionDate",
                "chgPostingStatus",
                "ddaSystem"
            ]
        }
    ]
}

Nested Schema : PostingInputDTO-allOf[0]

Type: object

Show Source

• accountccy(optional): string
  Account currency
• applicationCode(optional): string
  application code
• chargeCcy(optional): string
  charge currency
• chgPostedAmount(optional): number
  chg Amnt In Account curreny that got posted
• chgPostingError(optional): string
  Error Description in case charge error.
• chgPostingStatus: string
  Collection Status.
• chgRefno: string
  charge reference number
• collectionDate: string
  collection Date
• ddaSystem: string
  dda system
• exchgRate(optional): number
  exchange rate

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"application code"
        },
        "chgRefno":{
            "type":"string",
            "description":"charge reference number"
        },
        "collectionDate":{
            "type":"string",
            "description":"collection Date"
        },
        "chgPostingStatus":{
            "type":"string",
            "description":"Collection Status."
        },
        "chgPostingError":{
            "type":"string",
            "description":"Error Description in case charge error."
        },
        "ddaSystem":{
            "type":"string",
            "description":"dda system"
        },
        "accountccy":{
            "type":"string",
            "description":"Account currency"
        },
        "chargeCcy":{
            "type":"string",
            "description":"charge currency"
        },
        "chgPostedAmount":{
            "type":"number",
            "description":"chg Amnt In Account curreny that got posted"
        },
        "exchgRate":{
            "type":"number",
            "description":"exchange rate"
        }
    },
    "required":[
        "chgRefno",
        "collectionDate",
        "chgPostingStatus",
        "ddaSystem"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the charge maintenance actions based on given id.

Body ()

Root Schema : ChgPostingResponseWrapperDTO

Type: object

Show Source

• messages(optional): object ChgPostingResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ChgPostingResponseDto"
        }
    }
}

Nested Schema : ChgPostingResponseDto

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChgPostingResponseCode"
            }
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ChgPostingResponseCode

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

Nested Schema : ChgPostingResponseCode

Type: object

Show Source

• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

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