Jump to

• Request
• Response

Initiate the new dereconciliation transaction

post

/service/v1/initiateManualDerecon

This endpoint initiates new dereconciliation transaction on already reconciled transaction.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application id
• branchCode: string
  Branch Code
• userId: string
  User id

Body ()

Request Body to create dereconciliation transaction

Root Schema : DeReconTxnDto

Type: object

each recon txn deatail

Show Source

• deReconCnTxnDtoList(optional): array deReconCnTxnDtoList
• deReconPmtTxnDtoList(optional): array deReconPmtTxnDtoList
  reconcilation detail list with RHS as Payment
• id(optional): number
• isAutoAuth(optional): string
  auto-auth flag
• reconAction(optional): string
  Action Recon/Derecon
• reconCategory(optional): string
  Recon category baesd on LHS & RHS
• reconTxnRefNo(optional): string
  Transaction Ref No
• reconType(optional): string
  Recon category Auto/manual

{
    "description":"each recon txn deatail",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "reconTxnRefNo":{
            "type":"string",
            "description":"Transaction Ref No"
        },
        "reconCategory":{
            "type":"string",
            "description":"Recon category baesd on LHS & RHS"
        },
        "reconAction":{
            "type":"string",
            "description":"Action Recon/Derecon"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"auto-auth flag"
        },
        "reconType":{
            "type":"string",
            "description":"Recon category Auto/manual"
        },
        "deReconPmtTxnDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DeReconPmtDto"
            },
            "description":"reconcilation detail list with RHS as Payment"
        },
        "deReconCnTxnDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DeReconCnDto",
                "description":"reconcilation detail list with RHS as Credit Note"
            }
        }
    }
}

Nested Schema : deReconCnTxnDtoList

Type: array

Show Source

• Array of: object DeReconCnDto
  lhs and payment detail

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DeReconCnDto",
        "description":"reconcilation detail list with RHS as Credit Note"
    }
}

Nested Schema : deReconPmtTxnDtoList

Type: array

reconcilation detail list with RHS as Payment

Show Source

• Array of: object DeReconPmtDto
  lhs and payment detail

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DeReconPmtDto"
    },
    "description":"reconcilation detail list with RHS as Payment"
}

Nested Schema : DeReconCnDto

Type: object

lhs and payment detail

Show Source

• amtMatched(optional): number
  Amount to be dereconciled
• cnCcy(optional): string
• cnRefNo(optional): string
  internal Credit Note Ref No
• corporateId(optional): string
  Corporate Id
• externalCnRefNo(optional): string
• extLhsRefNo(optional): string
  External LHS Ref No
• id(optional): number
• intLhsRefNo(optional): string
  Internal LHS No
• lhsCcy(optional): string
  currency of LHS entity
• reconciledCnAmt(optional): number
• reconTxnRefNo(optional): string
  Transaction Ref No

{
    "description":"lhs and payment detail",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "reconTxnRefNo":{
            "type":"string",
            "description":"Transaction Ref No"
        },
        "extLhsRefNo":{
            "type":"string",
            "description":"External LHS Ref No"
        },
        "intLhsRefNo":{
            "type":"string",
            "description":"Internal LHS No"
        },
        "lhsCcy":{
            "type":"string",
            "description":"currency of LHS entity"
        },
        "amtMatched":{
            "type":"number",
            "description":"Amount to be dereconciled"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "cnRefNo":{
            "type":"string",
            "description":"internal Credit Note Ref No"
        },
        "cnCcy":{
            "type":"string",
            "description":""
        },
        "reconciledCnAmt":{
            "type":"number"
        },
        "externalCnRefNo":{
            "type":"string"
        }
    }
}

Nested Schema : DeReconPmtDto

Type: object

lhs and payment detail

Show Source

• amtMatched(optional): number
  Amount to be dereconciled
• corporateId(optional): string
  Corporate Id
• extLhsRefNo(optional): string
  External LHS Ref No
• extPmtRefNo(optional): string
  External Payment ref no
• id(optional): number
• intLhsRefNo(optional): string
  Internal LHS No
• lhsCcy(optional): string
  currency of LHS entity
• paymentCcy(optional): string
  Payment Currency
• paymentRefNo(optional): string
  Internal Payment ref no
• reconciledPmtAmt(optional): number
  Reconciled Amount in Payment Currency
• reconTxnRefNo(optional): string
  Transaction Ref No

{
    "description":"lhs and payment detail",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "reconTxnRefNo":{
            "type":"string",
            "description":"Transaction Ref No"
        },
        "extLhsRefNo":{
            "type":"string",
            "description":"External LHS Ref No"
        },
        "intLhsRefNo":{
            "type":"string",
            "description":"Internal LHS No"
        },
        "lhsCcy":{
            "type":"string",
            "description":"currency of LHS entity"
        },
        "amtMatched":{
            "type":"number",
            "description":"Amount to be dereconciled"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "paymentRefNo":{
            "type":"string",
            "description":"Internal Payment ref no"
        },
        "paymentCcy":{
            "type":"string",
            "description":"Payment Currency"
        },
        "reconciledPmtAmt":{
            "type":"number",
            "description":"Reconciled Amount in Payment Currency"
        },
        "extPmtRefNo":{
            "type":"string",
            "description":"External Payment ref no"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Successfully saved data

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Response DTO Wrapper

Show Source

• data(optional): object ResponseResourceSupport
  Response Resource Support
• messages(optional): object ResponseDto
  Response DTO

{
    "description":"Response DTO Wrapper",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Response Resource Support

Nested Schema : ResponseDto

Type: object

Response DTO

Show Source

• codes(optional): array codes
  Codes
• id(optional): string
  ID
• requestId(optional): string
  Request ID
• status(optional): string
  Status

{
    "description":"Response DTO",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

• Array of: object ResponseCode
  Response Code

{
    "type":"array",
    "description":"Codes",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Response Code

Show Source

• arg(optional): string
  Arg
• args(optional): array args
  Args
• Code(optional): string
  Code
• Desc(optional): string
  Description
• Language(optional): string
  Language
• Type(optional): string
  Type

{
    "description":"Response Code",
    "type":"object",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Args",
            "items":{
                "type":"object",
                "description":"Items"
            }
        },
        "arg":{
            "type":"string",
            "description":"Arg"
        }
    }
}

Nested Schema : args

Type: array

Args

Show Source

• Array of: object items
  Items

{
    "type":"array",
    "description":"Args",
    "items":{
        "type":"object",
        "description":"Items"
    }
}

Nested Schema : items

Type: object

Items

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