Jump to

• Request
• Response

Fetch the manual allocation transaction detail

post

/service/v1/getManualAlloc

This endpoint fetches manual allocation transaction detail based on given parameters.

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 search allocation transaction detail

Root Schema : ManualAllocSearchModel

Type: object

search parameters for manual alloc

Show Source

• allocAccount(optional): string
  Account Number
• allocDateFrom(optional): string
  Allocation date from
• allocDateTo(optional): string
  Allocation date to
• allocStatus(optional): string
  Allocation Status
• beneId(optional): string
  Beneficiary id
• corporateId(optional): string
  Corporate Id
• counterpartyId(optional): string
  Counterparty Id
• drCrIndicator(optional): string
  Debit credit indicator
• extPaymentRefNo(optional): string
  External Payment Ref No
• isAuth(optional): string
  flag for auth-authorization
• paymentPartyId(optional): string
  Payment Party Id
• paymentRefNo(optional): string
  Internal Payment Ref No
• reconCategory(optional): string
  Recon Category
• reconTxnRefNo(optional): string
  Transaction reference number
• reconType(optional): string
  Recon type Auto/manual

{
    "description":"search parameters for manual alloc",
    "type":"object",
    "properties":{
        "reconCategory":{
            "type":"string",
            "description":"Recon Category"
        },
        "reconType":{
            "type":"string",
            "description":"Recon type Auto/manual"
        },
        "reconTxnRefNo":{
            "type":"string",
            "description":"Transaction reference number"
        },
        "isAuth":{
            "type":"string",
            "description":"flag for auth-authorization"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "counterpartyId":{
            "type":"string",
            "description":"Counterparty Id"
        },
        "paymentRefNo":{
            "type":"string",
            "description":"Internal Payment Ref No"
        },
        "extPaymentRefNo":{
            "type":"string",
            "description":"External Payment Ref No"
        },
        "drCrIndicator":{
            "type":"string",
            "description":"Debit credit indicator"
        },
        "paymentPartyId":{
            "type":"string",
            "description":"Payment Party Id"
        },
        "beneId":{
            "type":"string",
            "description":"Beneficiary id"
        },
        "allocDateFrom":{
            "type":"string",
            "description":"Allocation date from"
        },
        "allocDateTo":{
            "type":"string",
            "description":"Allocation date to"
        },
        "allocAccount":{
            "type":"string",
            "description":"Account Number"
        },
        "allocStatus":{
            "type":"string",
            "description":"Allocation Status"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Successfully saved data

Body ()

Root Schema : ManualAllocCollection

Type: object

Collection of Allocation Transaction detail.

Show Source

• errCode(optional): string
  Error Code
• errDesc(optional): string
  Error Description
• manualAllocList(optional): array manualAllocList
  Allocation Detail list

{
    "description":"Collection of Allocation Transaction detail.",
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "manualAllocList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ManualAllocModel"
            },
            "description":"Allocation Detail list"
        }
    }
}

Nested Schema : manualAllocList

Type: array

Allocation Detail list

Show Source

• Array of: object ManualAllocModel
  search result for manual alloc

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ManualAllocModel"
    },
    "description":"Allocation Detail list"
}

Nested Schema : ManualAllocModel

Type: object

search result for manual alloc

Show Source

• allocAccount(optional): string
  Allocation Account Number
• allocAmount(optional): number
  Amount to be allocated in the transaction
• allocDate(optional): string
  date on which allocation happens
• allocStatus(optional): string
  Allocation transaction status
• allocType(optional): string
  Allocation type account/Attribute based
• drCrIndicator(optional): string
  Debit Credit indicator of payment
• errDesc(optional): string
  Error Description
• extPaymentRefNo(optional): string
  External Payment Reference Number
• isAuth(optional): string
  flag for auto-authorization of transaction
• paymentAmount(optional): number
  Actual Payment Amount
• paymentCcy(optional): string
  Payment Currency
• paymentRefNo(optional): string
  Internal Payment Reference number
• reconRule(optional): string
• reconRuleType(optional): string
• reconRuleVersion(optional): number
• reconTxnRefNo(optional): string
  Recon Transaction reference Number

{
    "description":"search result for manual alloc",
    "type":"object",
    "properties":{
        "reconTxnRefNo":{
            "type":"string",
            "description":"Recon Transaction reference Number"
        },
        "drCrIndicator":{
            "type":"string",
            "description":"Debit Credit indicator of payment"
        },
        "paymentRefNo":{
            "type":"string",
            "description":"Internal Payment Reference number"
        },
        "extPaymentRefNo":{
            "type":"string",
            "description":"External Payment Reference Number"
        },
        "paymentCcy":{
            "type":"string",
            "description":"Payment Currency"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Actual Payment Amount"
        },
        "isAuth":{
            "type":"string",
            "description":"flag for auto-authorization of transaction"
        },
        "allocAccount":{
            "type":"string",
            "description":"Allocation Account Number"
        },
        "allocAmount":{
            "type":"number",
            "description":"Amount to be allocated in the transaction"
        },
        "allocDate":{
            "type":"string",
            "description":"date on which allocation happens"
        },
        "allocStatus":{
            "type":"string",
            "description":"Allocation transaction status"
        },
        "allocType":{
            "type":"string",
            "description":"Allocation type account/Attribute based"
        },
        "errDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "reconRule":{
            "type":"string"
        },
        "reconRuleType":{
            "type":"string"
        },
        "reconRuleVersion":{
            "type":"number"
        }
    }
}

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