APIs

GET PARTY ARRANGEMENT DETAILS

This API uses the Party ID as a parameter to get the list arrangements for that Party.

GET/holdings/parties/{partyid}/bulkarrangements

Sample URL

http://localhost:8300/ms-arrangement-api/api/v1.0.0/holdings/parties/{partyid}/bulkarrangements

Response

{                            
  "arrangement": [
    {
      "arrangementId": "ARR20171J6HQK",
      "arrangementStatus": "AUTH",
      "originalContractDate": "2020-10-02",
      "role": [
        {
          "partyRole": "OWNER",
          "partyId": "GB0010001-1001000",
          "alternateReferences": [
            {
              "alternateId": 5544331001000,
              "alternateType": "MPID"
            }
          ],
          "extensionData": {}
        }
      ],
      "activeBranch": "BNK-Model Bank Branch",
      "accountCategory": 1001,
      "extSystemInfo": "string",
      "description": "string",
      "shortTitle": "Negotiable Account",
      "productLine": "ACCOUNTS",
      "arrangementRef": "string",
      "maturityDate": "2020-10-02",
      "additionalErrorInfo": "string",
      "currency": "USD",
      "company": {
        "companyReference": "GB0010001",
        "extensionData": {}
      },
      "productDescription": "Fully Negotiable Account",
      "externalIndicator": "string",
      "product": "NEGOTIABLE.ACCOUNT",
      "managingOfficer": "Implementation",
      "renewalDate": "2020-10-02",
      "creationDate": "2020-10-02",
      "postingRestrict": [
        {
          "restrictionType": "string",
          "description": "string",
          "postingRestrict": "string",
          "startDate": "string"
        }
      ],
      "extArrangementId": "GB0010001-AA191076TJVR",
      "extensionData": {},
      "productGroup": "CURRENT.ACCOUNTS",
      "relationshipPlan": "string",
      "closureDate": "2020-10-02",
      "dormancyStatus": "UNCLAIMED",
      "alternateReferences": [
        {
          "alternateId": 5544331001000,
          "alternateType": "MPID"
        }
      ],
      "arrangementStatusDate": "2020-10-02",
      "linkedReference": "GB0010001-88633",
      "overdueStatus": "OD2",
      "overdraftStatus": "OD3",
      "returnCode": 200
    }
  ]
}

GET BULK ARRANGEMENTS

This API is used to get the arrangement details and accounts for the list of arrangement IDs or their alternate references.

GET/holdings/bulkarrangements/{arrangementid}

Sample URL

http://localhost:8300/ms-arrangement-api/api/v1.0.0/holdings/bulkarrangements/{arrangementid}

Response

{
  "arrangementResponse": [
    {
      "arrangementId": "ARR20171J6HQK",
      "arrangementStatus": "AUTH",
      "originalContractDate": "2020-10-02",
      "role": [
        {
          "partyRole": "OWNER",
          "partyId": "GB0010001-1001000",
          "alternateReferences": [
            {
              "alternateId": 5544331001000,
              "alternateType": "MPID"
            }
          ],
          "extensionData": {}
        }
      ],
      "activeBranch": "BNK-Model Bank Branch",
      "accountCategory": 1001,
      "extSystemInfo": "string",
      "description": "string",
      "shortTitle": "Negotiable Account",
      "productLine": "ACCOUNTS",
      "arrangementRef": "string",
      "maturityDate": "2020-10-02",
      "additionalErrorInfo": "string",
      "currency": "USD",
      "company": {
        "companyReference": "GB0010001",
        "extensionData": {}
      },
      "productDescription": "Fully Negotiable Account",
      "externalIndicator": "string",
      "product": "NEGOTIABLE.ACCOUNT",
      "managingOfficer": "Implementation",
      "renewalDate": "2020-10-02",
      "creationDate": "2020-10-02",
      "postingRestrict": [
        {
          "restrictionType": "string",
          "description": "string",
          "postingRestrict": "string",
          "startDate": "string"
        }
      ],
      "extArrangementId": "GB0010001-AA191076TJVR",
      "extensionData": {},
      "productGroup": "CURRENT.ACCOUNTS",
      "relationshipPlan": "string",
      "closureDate": "2020-10-02",
      "dormancyStatus": "UNCLAIMED",
      "alternateReferences": [
        {
          "alternateId": 5544331001000,
          "alternateType": "MPID"
        }
      ],
      "arrangementStatusDate": "2020-10-02",
      "linkedReference": "GB0010001-88633",
      "overdueStatus": "OD2",
      "overdraftStatus": "OD3",
      "returnCode": 200
    }
  ]
}

GET PARTY ROLE

This API is used to get the Party ID as a parameter to get the roles for a party

GET/holdings/arrangement/{arrangementid}/roles

Sample URL

http://localhost:8300/ms-arrangement-api/api/v1.0.0/holdings/arrangement/{arrangementid}/roles

Response

{
  "roles": [
    {
      "arrangementId": "string",
      "role": "OWNER",
      "partyId": "GB0010001-1001001",
      "alternateReferences": [
        {
          "alternateId": 5544331001000,
          "alternateType": "MPID"
        }
      ],
      "extensionData": {},
      "linkedReference": "GB0010001-88633"
    }
  ]
}

GET PAYMENT SCHEDULES

This API is used to get the payment schedules for a specific arrangement ID.

GET/holdings/arrangement/{arrangementid}/schedules

Sample URL

http://localhost:8300/ms-arrangement-api/api/v1.0.0/holdings/arrangement/{arrangementid}/schedules

Response

{
  "paymentSchedule": [
    {
      "scheduleDate": "2020-10-02",
      "PrincipleAmount": 50000,
      "taxAmount": 50.45,
      "InterestAmount": 10.95,
      "ChargeAmount": 100,
      "status": "SETTLED"
    }
  ]
}

GET PAYMENT SCHEDULE STATUS

This API is used to get the payment schedule status for a specific arrangement ID.

GET/holdings/arrangement/{arrangementid}/schedulestatus

Sample URL

http://localhost:8300/ms-arrangement-api/api/v1.0.0/holdings/arrangement/{arrangementid}/schedulestatus

Response

{
  "scheduleStatus": {
    "dueScheduleCount": 2,
    "paidScheduleCount": 1,
    "futureScheduleCount": 3
  }
}