Jump to

• Request
• Response

Fetch all the arrangement decisioning maintenance

get

/service/v1/decisioningmaster

This API fetches all the arrangement decisioning maintenance based on given parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• arrangementParty(optional): string
  arrangementParty need to be set to fetch summary record
• authStatus(optional): string
  authStatus need to be set to fetch summary record
• filterCriteria(optional): string
  filterCriteria need to be set to fetch summary record
• includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• product(optional): string
  product need to be set to fetch summary record
• recordStatus(optional): string
  recordStatus need to be set to fetch summary record

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  Name of the Location.

Body ()

Root Schema : ObcmTmDecisioningMasterCollection

Type: object

Collection of decisioning Master Objects.

Show Source

• data(optional): array data
  Data.
• paging(optional): object PagingDto

{
    "type":"object",
    "description":"Collection of decisioning Master Objects.",
    "properties":{
        "data":{
            "type":"array",
            "description":"Data.",
            "items":{
                "$ref":"#/definitions/ObcmTmDecisioningMasterDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Data.

Show Source

• Array of: object ObcmTmDecisioningMasterDTO
  OBCM TM Decisioning Master DTO

{
    "type":"array",
    "description":"Data.",
    "items":{
        "$ref":"#/definitions/ObcmTmDecisioningMasterDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : ObcmTmDecisioningMasterDTO

Type: object

OBCM TM Decisioning Master DTO

Match All

Show Source

• allOf GenericDto
• object ObcmTmDecisioningMasterDTO-allOf[1]

{
    "type":"object",
    "description":"OBCM TM Decisioning Master DTO",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "agreementRefNumber":{
                    "type":"string",
                    "description":"Agreement Reference Number."
                },
                "amountBasedArrangement":{
                    "type":"string",
                    "description":"Amount Based Arrangement."
                },
                "arrangementParty":{
                    "type":"string",
                    "description":"Arrangement Party."
                },
                "arrangementPartyName":{
                    "type":"string",
                    "description":"Arrangement Party Name."
                },
                "centralizedForwardSchedule":{
                    "type":"string",
                    "description":"Centralized Forward Schedule."
                },
                "corporate":{
                    "type":"string",
                    "description":"Corporate Name."
                },
                "corporateId":{
                    "type":"string",
                    "description":"Corporate Id."
                },
                "correspondentBank":{
                    "type":"string",
                    "description":"Correspondant Bank Name."
                },
                "correspondentBankId":{
                    "type":"string",
                    "description":"Correspondant Bank Id."
                },
                "draweebankId":{
                    "type":"string",
                    "description":"Drawee Bank Id."
                },
                "draweeBank":{
                    "type":"string",
                    "description":"Drawee Bank."
                },
                "effectiveDate":{
                    "type":"string",
                    "description":"Effective Date."
                },
                "expiryDate":{
                    "type":"string",
                    "description":"Expiry Date."
                },
                "filterCriteria":{
                    "type":"string",
                    "description":"Filter Criteria."
                },
                "inclusionOfHolidays":{
                    "type":"string",
                    "description":"Inclusion Of Holidays."
                },
                "locationId":{
                    "type":"string",
                    "description":"Location Id."
                },
                "locationName":{
                    "type":"string",
                    "description":"Location Name."
                },
                "product":{
                    "type":"string",
                    "description":"Product Name."
                },
                "productId":{
                    "type":"string",
                    "description":"Product Id."
                },
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"Transaction Controller Reference No."
                },
                "ObcmTmDecisioningDetailsDTO":{
                    "type":"array",
                    "description":"Obcm Tm Decisioning Details.",
                    "items":{
                        "$ref":"#/definitions/ObcmTmDecisioningDetailsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ObcmTmDecisioningMasterDTO-allOf[1]

Type: object

Show Source

• agreementRefNumber(optional): string
  Agreement Reference Number.
• amountBasedArrangement(optional): string
  Amount Based Arrangement.
• arrangementParty(optional): string
  Arrangement Party.
• arrangementPartyName(optional): string
  Arrangement Party Name.
• centralizedForwardSchedule(optional): string
  Centralized Forward Schedule.
• corporate(optional): string
  Corporate Name.
• corporateId(optional): string
  Corporate Id.
• correspondentBank(optional): string
  Correspondant Bank Name.
• correspondentBankId(optional): string
  Correspondant Bank Id.
• draweeBank(optional): string
  Drawee Bank.
• draweebankId(optional): string
  Drawee Bank Id.
• effectiveDate(optional): string
  Effective Date.
• expiryDate(optional): string
  Expiry Date.
• filterCriteria(optional): string
  Filter Criteria.
• inclusionOfHolidays(optional): string
  Inclusion Of Holidays.
• locationId(optional): string
  Location Id.
• locationName(optional): string
  Location Name.
• ObcmTmDecisioningDetailsDTO(optional): array ObcmTmDecisioningDetailsDTO
  Obcm Tm Decisioning Details.
• product(optional): string
  Product Name.
• productId(optional): string
  Product Id.
• txnControllerRefNo(optional): string
  Transaction Controller Reference No.

{
    "type":"object",
    "properties":{
        "agreementRefNumber":{
            "type":"string",
            "description":"Agreement Reference Number."
        },
        "amountBasedArrangement":{
            "type":"string",
            "description":"Amount Based Arrangement."
        },
        "arrangementParty":{
            "type":"string",
            "description":"Arrangement Party."
        },
        "arrangementPartyName":{
            "type":"string",
            "description":"Arrangement Party Name."
        },
        "centralizedForwardSchedule":{
            "type":"string",
            "description":"Centralized Forward Schedule."
        },
        "corporate":{
            "type":"string",
            "description":"Corporate Name."
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id."
        },
        "correspondentBank":{
            "type":"string",
            "description":"Correspondant Bank Name."
        },
        "correspondentBankId":{
            "type":"string",
            "description":"Correspondant Bank Id."
        },
        "draweebankId":{
            "type":"string",
            "description":"Drawee Bank Id."
        },
        "draweeBank":{
            "type":"string",
            "description":"Drawee Bank."
        },
        "effectiveDate":{
            "type":"string",
            "description":"Effective Date."
        },
        "expiryDate":{
            "type":"string",
            "description":"Expiry Date."
        },
        "filterCriteria":{
            "type":"string",
            "description":"Filter Criteria."
        },
        "inclusionOfHolidays":{
            "type":"string",
            "description":"Inclusion Of Holidays."
        },
        "locationId":{
            "type":"string",
            "description":"Location Id."
        },
        "locationName":{
            "type":"string",
            "description":"Location Name."
        },
        "product":{
            "type":"string",
            "description":"Product Name."
        },
        "productId":{
            "type":"string",
            "description":"Product Id."
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference No."
        },
        "ObcmTmDecisioningDetailsDTO":{
            "type":"array",
            "description":"Obcm Tm Decisioning Details.",
            "items":{
                "$ref":"#/definitions/ObcmTmDecisioningDetailsDTO"
            }
        }
    }
}

Nested Schema : ObcmTmDecisioningDetailsDTO

Type: array

Obcm Tm Decisioning Details.

Show Source

• Array of: object ObcmTmDecisioningDetailsDTO
  OBCM TM Decisioning Details.

{
    "type":"array",
    "description":"Obcm Tm Decisioning Details.",
    "items":{
        "$ref":"#/definitions/ObcmTmDecisioningDetailsDTO"
    }
}

Nested Schema : ObcmTmDecisioningDetailsDTO

Type: object

OBCM TM Decisioning Details.

Show Source

• arrangementCode(optional): string
  Arrangement Code.
• arrangementDays(optional): number
  Arrangement Days.
• arrangementRefBasis(optional): string
  Arrangement Reference Basis.
• bankFloatArrangement(optional): string
  Bank Float Arrangement.
• certificateExtensionDays(optional): number
  Certification Extension Days.
• corporateReleaseDays(optional): number
  Corporate Release Days.
• creditReversalDays(optional): number
  Credit Reversal Days.
• creditReversalFrom(optional): string
  Credit Reversal From.
• currency(optional): string
  Currency.
• decisioningMasterId(optional): string
  Decisioning Master Id.
• forcedDebitForRecovery(optional): string
  Forced Debit For Recovery.
• fromAmount(optional): number
  From Amount.
• id(optional): string
  Id
• linkArrangement(optional): string
  Arrangement Linked (Y/N).
• lostExtensionDays(optional): number
  Lost Extension Days.
• partialCreditReversal(optional): string
  Partial Credit Reversal.
• partialReturnRecovery(optional): string
  Partial Return Recovery.
• returnExtensionDays(optional): number
  Return Extension Days.
• returnRecoveryFrom(optional): string
  Return Recovery From.
• toAmount(optional): number
  To Amount.

{
    "type":"object",
    "description":"OBCM TM Decisioning Details.",
    "properties":{
        "arrangementCode":{
            "type":"string",
            "description":"Arrangement Code."
        },
        "currency":{
            "type":"string",
            "description":"Currency."
        },
        "arrangementDays":{
            "type":"number",
            "description":"Arrangement Days."
        },
        "arrangementRefBasis":{
            "type":"string",
            "description":"Arrangement Reference Basis."
        },
        "certificateExtensionDays":{
            "type":"number",
            "description":"Certification Extension Days."
        },
        "corporateReleaseDays":{
            "type":"number",
            "description":"Corporate Release Days."
        },
        "decisioningMasterId":{
            "type":"string",
            "description":"Decisioning Master Id."
        },
        "fromAmount":{
            "type":"number",
            "description":"From Amount."
        },
        "toAmount":{
            "type":"number",
            "description":"To Amount."
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "linkArrangement":{
            "type":"string",
            "description":"Arrangement Linked (Y/N)."
        },
        "lostExtensionDays":{
            "type":"number",
            "description":"Lost Extension Days."
        },
        "returnExtensionDays":{
            "type":"number",
            "description":"Return Extension Days."
        },
        "creditReversalDays":{
            "type":"number",
            "description":"Credit Reversal Days."
        },
        "creditReversalFrom":{
            "type":"string",
            "description":"Credit Reversal From."
        },
        "partialCreditReversal":{
            "type":"string",
            "description":"Partial Credit Reversal."
        },
        "bankFloatArrangement":{
            "type":"string",
            "description":"Bank Float Arrangement."
        },
        "returnRecoveryFrom":{
            "type":"string",
            "description":"Return Recovery From."
        },
        "partialReturnRecovery":{
            "type":"string",
            "description":"Partial Return Recovery."
        },
        "forcedDebitForRecovery":{
            "type":"string",
            "description":"Forced Debit For Recovery."
        }
    }
}

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