APIs
(missing or bad snippet)
- Version 1.0.0
- Version 2.0.0
Version 1.0.0
The following are the supported APIs in Version 1.0.0.
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}/bulkarrangementsResponse
{
"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}/rolesResponse
{
"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}/schedulesResponse
{
"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}/schedulestatusResponse
{
"scheduleStatus": {
"dueScheduleCount": 2,
"paidScheduleCount": 1,
"futureScheduleCount": 3
}
}Version 2.0.0
The following are the supported APIs in Version 2.0.0.
GET Party Arrangement Details
This API is used to
retrieve all the arrangement details of the partyId.
GET/v2.0.0/holdings/parties/{partyid}/bulkarrangements
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/holdings/parties/{partyid}/bulkarrangementsResponse
{
"arrangement": [
{
"arrangementId": "ARR202660H2EBX93IM",
"accountCategory": 83,
"arrangementStatus": "AUTH",
"arrangementStatusDate": "2020-09-22 05:43:34.0",
"country": "GB",
"creationDate": "2020-09-22 05:43:34.0",
"currency": "USD",
"description": "Accounts Arrangement",
"dormancyStatus": "Pending",
"eStmtEnabled": true,
"extArrangementId": "GB0010001-AA20079Z2QSV",
"extSystemInfo": "AA20079Z2QSV",
"externalIndicator": false,
"linkedReference": "GB0010001-89707",
"originalContractDate": "2020-09-22 05:43:34.0",
"productLine": "ACCOUNTS",
"productGroup": "CURRENT.ACCOUNTS",
"product": "SME.ACCOUNT",
"relationshipPlan": "Unauth",
"shortTitle": "MR.",
"activeBranch": "GB00010001",
"managingOfficer": 26,
"company": {
"companyReference": "GB0010001"
},
"productDescription": "Current Account (SME)",
"role": [
{
"partyId": "GB0010001-100100",
"partyRole": "Owner",
"alternateReferences": [
{
"alternateType": 554433100100,
"alternateId": "MPID"
}
]
}
],
"postingRestrict": [
{
"postingRestrict": 1,
"restrictionType": "DEBITS",
"description": "Posting No Debit",
"startDate": "2020-09-22 05:43:34.0"
}
],
"arrangementRef": "ARR202660H2EBX93IM",
"iban": "AL47212110090000000235698741",
"returnCode": 404,
"additionalErrorInfo": "Arrangement Failed",
"processDate": "2020-09-22 05:43:34.0",
"lendingArrangement": {
"maturityDate": "2020-09-22 05:43:34.0",
"renewalDate": "2020-09-22 05:43:34.0",
"overdueStatus": "Pending",
"principalAmount": 500.06,
"termAmount": 500.06,
"sanctionedDate": "2020-09-22 05:43:34.0",
"lastPaymentDate": "2020-09-22 05:43:34.0",
"lastPaymentAmount": 500.06,
"totalDueAmount": 500.06,
"dueDate": "2020-09-22 05:43:34.0",
"currentDue": 500.06
},
"accountArrangement": {
"closureDate": "2020-09-22 05:43:34.0",
"overdraftStatus": "Pending"
},
"depositArrangement": {
"maturityDate": "2020-09-22 05:43:34.0",
"renewalDate": "2020-09-22 05:43:34.0"
},
"alternateReferences": [
{
"alternateType": 554433100100,
"alternateId": "MPID"
}
]
}
]
}GET Bulk Arrangements
This API is used to
retrieve arrangement details for the list of arrangementid/IBAN.
GET/v2.0.0/holdings/bulkarrangements/{arrangementid}
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/holdings/bulkarrangements/{arrangementid}Response
{
"arrangementResponse": [
{
"arrangementId": "ARR202660H2EBX93IM",
"accountCategory": 83,
"arrangementStatus": "AUTH",
"arrangementStatusDate": "2020-09-22 05:43:34.0",
"country": "GB",
"creationDate": "2020-09-22 05:43:34.0",
"currency": "USD",
"description": "Accounts Arrangement",
"dormancyStatus": "Pending",
"eStmtEnabled": true,
"extArrangementId": "GB0010001-AA20079Z2QSV",
"extSystemInfo": "AA20079Z2QSV",
"externalIndicator": false,
"linkedReference": "GB0010001-89707",
"originalContractDate": "2020-09-22 05:43:34.0",
"productLine": "ACCOUNTS",
"productGroup": "CURRENT.ACCOUNTS",
"product": "SME.ACCOUNT",
"relationshipPlan": "Unauth",
"shortTitle": "MR.",
"activeBranch": "GB00010001",
"managingOfficer": 26,
"company": {
"companyReference": "GB0010001"
},
"productDescription": "Current Account (SME)",
"role": [
{
"partyId": "GB0010001-100100",
"partyRole": "Owner",
"alternateReferences": [
{
"alternateType": 554433100100,
"alternateId": "MPID"
}
]
}
],
"postingRestrict": [
{
"postingRestrict": 1,
"restrictionType": "DEBITS",
"description": "Posting No Debit",
"startDate": "2020-09-22 05:43:34.0"
}
],
"arrangementRef": "ARR202660H2EBX93IM",
"iban": "AL47212110090000000235698741",
"returnCode": 404,
"additionalErrorInfo": "Arrangement Failed",
"processDate": "2020-09-22 05:43:34.0",
"lendingArrangement": {
"maturityDate": "2020-09-22 05:43:34.0",
"renewalDate": "2020-09-22 05:43:34.0",
"overdueStatus": "Pending",
"principalAmount": 500.06,
"termAmount": 500.06,
"sanctionedDate": "2020-09-22 05:43:34.0",
"lastPaymentDate": "2020-09-22 05:43:34.0",
"lastPaymentAmount": 500.06,
"totalDueAmount": 500.06,
"dueDate": "2020-09-22 05:43:34.0",
"currentDue": 500.06
},
"accountArrangement": {
"closureDate": "2020-09-22 05:43:34.0",
"overdraftStatus": "Pending"
},
"depositArrangement": {
"maturityDate": "2020-09-22 05:43:34.0",
"renewalDate": "2020-09-22 05:43:34.0"
},
"alternateReferences": [
{
"alternateType": 554433100100,
"alternateId": "MPID"
}
]
}
]
}GET Schedule For Arrangement
This API is used to
retrieve payment schedules for the ArrangementId.
GET/v2.0.0/holdings/arrangement/{arrangementid}/schedules
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/holdings/arrangement/{arrangementid}/schedulesResponse
{
"paymentSchedule": [
{
"scheduleDate": "2020-01-01",
"PrincipleAmount": 15.06,
"taxAmount": 15.06,
"InterestAmount": 15.06,
"ChargeAmount": 15.06,
"status": "Pending",
"outstandingBalance": 15.06,
"settledDate": "2020-01-01"
}
]
}GET Schedule Status For Arrangement
This API is used to
retrieve payment schedules for the ArrangementId.
GET/v2.0.0/holdings/arrangement/{arrangementid}/schedulestatus
Sample URL
http://localhost:8002/ms-marketingcatalog-api/api/v2.0.0/holdings/arrangement/{arrangementid}/schedulestatusResponse
{
"scheduleStatus": {
"dueScheduleCount": 15,
"paidScheduleCount": 15,
"futureScheduleCount": 15
}
}Field Name
|
Application/Table name
In this topic