Jump to

• Request
• Response

Retrieves the internal account mapping

post

/ob/scf/v1/internalAccountMapping/.search

This endpoint is used to retrieves the internal account mapping by ID.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  Application Id
• branchCode(required): string
  branchCode
• userId(required): string
  userId

Body ()

Request Body that contains response status for external systems

Root Schema : IntAccMapReq

Type: object

Request body to update external system response

Show Source

• accountName: string
  account name
• accountNo: string
  account number
• accountType: string
  Account Type
• applicationName: string
  Application Name
• event: string
  Event
• isLoanAccountCredited: string
  debit or credit account to be fetched
• limit: integer
  limit is maximum no of records to be fetched
• offset: integer
  offset is starting no of records to be fetched
• paymentParty: string
  Payment Party

{
    "description":"Request body to update external system response",
    "type":"object",
    "properties":{
        "paymentParty":{
            "description":"Payment Party",
            "type":"string"
        },
        "accountType":{
            "description":"Account Type",
            "type":"string"
        },
        "event":{
            "description":"Event",
            "type":"string"
        },
        "accountNo":{
            "description":"account number",
            "type":"string"
        },
        "accountName":{
            "description":"account name",
            "type":"string"
        },
        "isLoanAccountCredited":{
            "description":"debit or credit account to be fetched",
            "type":"string"
        },
        "applicationName":{
            "description":"Application Name",
            "type":"string"
        },
        "offset":{
            "description":"offset is starting no of records to be fetched",
            "type":"integer"
        },
        "limit":{
            "description":"limit is maximum no of records to be fetched",
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the intaccmap based on given id.

Body ()

Root Schema : ScfcmTmIntAccMapMasterCollection

Type: object

Collection of scfcmtmintaccmapmaster.

Show Source

• data: array data
• paging: object PagingDto

{
    "description":"Collection of scfcmtmintaccmapmaster.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmIntAccMapMasterDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ScfTmIntAccMapMasterDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : ScfTmIntAccMapMasterDTO

Type: object

Show Source

• accInTxnCcy: string
  Account In Transaction Currency
• accRoleCode: string
  Account Role Code
• accType: string
  AccountType
• action: string
  Action
• applicationCode: string
  Application Code
• autoAuth: string
  Auto Auth
• branchCode: string
  Branch Code
• checkerRemarks: string
  Checker Remarks
• datasegmentCode: string
  Data Segment Code
• filterAttr1: string
  Filter Attribute 1
• filterAttr1Name: string
  Filter Attribute 1 Name
• filterAttr2: string
  Filter Attribute 2
• filterAttr2Name: string
  Filter Attribute 2 Name
• filterAttr3: string
  Filter Attribute 3
• filterAttr3Name: string
  Filter Attribute 3 Name
• filterAttr4: string
  Filter Attribute 4
• filterAttr4Name: string
  Filter Attribute 4 Name
• filterAttr5: string
  Filter Attribute 5
• filterAttr5Name: string
  Filter Attribute 5 Name
• filterCriteria: string
  Filter Criteria
• filterCriteriaDesc: string
  Filter Criteria Description
• filterParameters: string
  Filter Parameters
• id: string
  Id
• makerRemarks: string
  Maker Remarks
• modificationStatus: string
  Modification Status
• productCode: string
  Product Code
• ScfTmIntAccMapDetailsDTO: array ScfTmIntAccMapDetailsDTO
• settlementMethod: string
  Settlement Method

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "autoAuth":{
            "type":"string",
            "description":"Auto Auth"
        },
        "modificationStatus":{
            "type":"string",
            "description":"Modification Status"
        },
        "datasegmentCode":{
            "type":"string",
            "description":"Data Segment Code"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"Checker Remarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"Maker Remarks"
        },
        "accInTxnCcy":{
            "type":"string",
            "description":"Account In Transaction Currency"
        },
        "accRoleCode":{
            "type":"string",
            "description":"Account Role Code"
        },
        "accType":{
            "type":"string",
            "description":"AccountType"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "filterAttr1":{
            "type":"string",
            "description":"Filter Attribute 1"
        },
        "filterAttr1Name":{
            "type":"string",
            "description":"Filter Attribute 1 Name"
        },
        "filterAttr2":{
            "type":"string",
            "description":"Filter Attribute 2"
        },
        "filterAttr2Name":{
            "type":"string",
            "description":"Filter Attribute 2 Name"
        },
        "filterAttr3":{
            "type":"string",
            "description":"Filter Attribute 3"
        },
        "filterAttr3Name":{
            "type":"string",
            "description":"Filter Attribute 3 Name"
        },
        "filterAttr4":{
            "type":"string",
            "description":"Filter Attribute 4"
        },
        "filterAttr4Name":{
            "type":"string",
            "description":"Filter Attribute 4 Name"
        },
        "filterAttr5":{
            "type":"string",
            "description":"Filter Attribute 5"
        },
        "filterAttr5Name":{
            "type":"string",
            "description":"Filter Attribute 5 Name"
        },
        "filterCriteria":{
            "type":"string",
            "description":"Filter Criteria"
        },
        "filterCriteriaDesc":{
            "type":"string",
            "description":"Filter Criteria Description"
        },
        "filterParameters":{
            "type":"string",
            "description":"Filter Parameters"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "settlementMethod":{
            "type":"string",
            "description":"Settlement Method"
        },
        "applicationCode":{
            "type":"string",
            "description":"Application Code"
        },
        "ScfTmIntAccMapDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmIntAccMapDetailsDTO"
            }
        }
    }
}

Match All

Show Source

• allOf GenericDto
• object ScfTmIntAccMapMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "autoAuth":{
            "type":"string",
            "description":"Auto Auth"
        },
        "modificationStatus":{
            "type":"string",
            "description":"Modification Status"
        },
        "datasegmentCode":{
            "type":"string",
            "description":"Data Segment Code"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"Checker Remarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"Maker Remarks"
        },
        "accInTxnCcy":{
            "type":"string",
            "description":"Account In Transaction Currency"
        },
        "accRoleCode":{
            "type":"string",
            "description":"Account Role Code"
        },
        "accType":{
            "type":"string",
            "description":"AccountType"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "filterAttr1":{
            "type":"string",
            "description":"Filter Attribute 1"
        },
        "filterAttr1Name":{
            "type":"string",
            "description":"Filter Attribute 1 Name"
        },
        "filterAttr2":{
            "type":"string",
            "description":"Filter Attribute 2"
        },
        "filterAttr2Name":{
            "type":"string",
            "description":"Filter Attribute 2 Name"
        },
        "filterAttr3":{
            "type":"string",
            "description":"Filter Attribute 3"
        },
        "filterAttr3Name":{
            "type":"string",
            "description":"Filter Attribute 3 Name"
        },
        "filterAttr4":{
            "type":"string",
            "description":"Filter Attribute 4"
        },
        "filterAttr4Name":{
            "type":"string",
            "description":"Filter Attribute 4 Name"
        },
        "filterAttr5":{
            "type":"string",
            "description":"Filter Attribute 5"
        },
        "filterAttr5Name":{
            "type":"string",
            "description":"Filter Attribute 5 Name"
        },
        "filterCriteria":{
            "type":"string",
            "description":"Filter Criteria"
        },
        "filterCriteriaDesc":{
            "type":"string",
            "description":"Filter Criteria Description"
        },
        "filterParameters":{
            "type":"string",
            "description":"Filter Parameters"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "settlementMethod":{
            "type":"string",
            "description":"Settlement Method"
        },
        "applicationCode":{
            "type":"string",
            "description":"Application Code"
        },
        "ScfTmIntAccMapDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmIntAccMapDetailsDTO"
            }
        }
    }
}

Nested Schema : ScfTmIntAccMapDetailsDTO

Type: array

Show Source

• Array of: object ScfTmIntAccMapDetailsDTO

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

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 : ScfTmIntAccMapMasterDTO-allOf[1]

Type: object

Nested Schema : ScfTmIntAccMapDetailsDTO

Type: object

Show Source

• accountCcy: string
  Account Currency
• accountName: string
  Account Name
• accountNo: string
  Account Number
• contraAccNo: string
  Contra Account Number
• defaultAccount: string
  Default Account
• id: string
  Id
• intMasterId: string
  Int Master Id
• vaFlagYN: string
  Virtual Account flag as Y or N

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "accountCcy":{
            "type":"string",
            "description":"Account Currency"
        },
        "accountName":{
            "type":"string",
            "description":"Account Name"
        },
        "accountNo":{
            "type":"string",
            "description":"Account Number"
        },
        "defaultAccount":{
            "type":"string",
            "description":"Default Account"
        },
        "intMasterId":{
            "type":"string",
            "description":"Int Master Id"
        },
        "vaFlagYN":{
            "type":"string",
            "description":"Virtual Account flag as Y or N"
        },
        "contraAccNo":{
            "type":"string",
            "description":"Contra Account Number"
        }
    }
}

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